Skip to main content
Version: 2.1

Source

To use source sdk client we need retrive from the SDK using rumsanService.client

  const sourceclient =  getSourceClient(rumsanService.client);

As the mutation function or query function may contain some payload to be pass which are the parmaeter.

sourceclient.create
ParameterTypeDescription
actionstring \| undefinedOptional action associated with the entity.
namestringName of the entity.
isImportedboolean \| undefinedIndicates if the entity is imported.
detailsanyAdditional details or data related to the entity.
fieldMappinganyMapping of fields related to the entity.
Response
 success: true
data: {
id: number
action: string
uuid: `${string}-${string}-${string}-${string}-${string}`
name: string
isImported: boolean
details: any
fieldMapping: any
createdAt: Date
updatedAt: Date
}


Response
 success: true
data: [
{
id: number
action: string
uuid: `${string}-${string}-${string}-${string}-${string}`
name: string
isImported: boolean
details: any
fieldMapping: any
createdAt: Date
updatedAt: Date
}
]

sourceclient.listById
ParameterTypeDescription
uuidstringUUID identifying the source
Response
 success: true
data:
{
id: number
action: string
uuid: `${string}-${string}-${string}-${string}-${string}`
name: string
isImported: boolean
details: any
fieldMapping: any
createdAt: Date
updatedAt: Date
}

sourceclient.update

ParameterTypeDescription
uuidstringUUID identifying the source
actionstring \| undefinedOptional action associated with the entity.
namestringName of the entity.
isImportedboolean \| undefinedIndicates if the entity is imported.
detailsanyAdditional details or data related to the entity.
fieldMappinganyMapping of fields related to the entity.
Response
 success: true
data: {
id: number
action: string
uuid: `${string}-${string}-${string}-${string}-${string}`
name: string
isImported: boolean
details: any
fieldMapping: any
createdAt: Date
updatedAt: Date
}

sourceclient.remove

ParameterTypeDescription
uuidstringUUID identifying the source
Response
 success: true
data: {
id: number
action: string
uuid: `${string}-${string}-${string}-${string}-${string}`
name: string
isImported: boolean
details: any
fieldMapping: any
createdAt: Date
updatedAt: Date
}

sourceclient.importIdMapping
ParameterType
importIdstring
Response
 success: true