Last updated 10 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Get workflow report generation
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/parameter/getWorkFlowRepGen HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 151 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WorkFlowRepGenSpecfile": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "WorkFlowRepGen": { "Specfile": 1, "SpecfileDescription": "text", "SpecfileName": "text" } }
Get workflow report generation select fields
POST /nexum/627/2022.01/parameter/getWorkFlowRepGenSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 298 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WorkFlowRepGenSpecfile": 1, "SelectableFields": { "IncludeAllWorkFlowRepGenFields": true, "WorkFlowRepGenFields": { "Specfile": true, "SpecfileDescription": true, "SpecfileName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Get workflow report generation paged list
POST /nexum/627/2022.01/parameter/getWorkFlowRepGenPagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 218 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "WorkFlowRepGen": [ { "Specfile": 1, "SpecfileDescription": "text", "SpecfileName": "text" } ], "Token": "text" }
Get workflow report generation list select fields
POST /nexum/627/2022.01/parameter/getWorkFlowRepGenListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 271 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllWorkFlowRepGenFields": true, "WorkFlowRepGenFields": { "Specfile": true, "SpecfileDescription": true, "SpecfileName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "WorkFlowRepGenList": { "hasReachedMaximumListSize": true, "WorkFlowRepGen": [ { "Specfile": 1, "SpecfileDescription": "text", "SpecfileName": "text" } ] } }
Fields available for selecting when retrieving Workflow Report Generation data
POST /nexum/627/2022.01/parameter/searchWorkFlowRepGenSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 303 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllWorkFlowRepGenFields": true, "WorkFlowRepGenFields": { "Specfile": true, "SpecfileDescription": true, "SpecfileName": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Get workflow report generation paged list select fields
POST /nexum/627/2022.01/parameter/getWorkFlowRepGenPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 365 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWorkFlowRepGenFields": true, "WorkFlowRepGenFields": { "Specfile": true, "SpecfileDescription": true, "SpecfileName": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Fields available for selecting when retrieving paginated Workflow Report Generation data
POST /nexum/627/2022.01/parameter/searchWorkFlowRepGenPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 380 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWorkFlowRepGenFields": true, "WorkFlowRepGenFields": { "Specfile": true, "SpecfileDescription": true, "SpecfileName": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update Workflow Report Generation for a specific ID.
POST /nexum/627/2022.01/parameter/updateWorkFlowRepGenByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 236 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WorkFlowRepGenSpecfile": 1, "WorkFlowRepGenUpdatableFields": { "SpecfileDescription": "text", "SpecfileName": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }