Last updated 10 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Get yellow hammer
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/getYellowHammer HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 124 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "YellowHammer": { "Description": [ { "EntryId": 1, "Description": "text" } ], "Enabled": true, "ErrorMessage": "text", "ExemptServiceCode": 1, "Privilege": [ { "EntryId": 1, "Privilege": 1 } ], "RuleId": [ { "EntryId": 1, "RuleId": 1 } ], "Warning": [ { "EntryId": 1, "Warning": true } ] } }
Get yellow hammer select fields
POST /nexum/627/2022.01/parameter/getYellowHammerSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 325 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllYellowHammerFields": true, "YellowHammerFields": { "Description": [ 1 ], "Enabled": true, "ErrorMessage": true, "ExemptServiceCode": true, "Privilege": [ 1 ], "RuleId": [ 1 ], "Warning": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update Yellow Hammer for a specific ID.
POST /nexum/627/2022.01/parameter/updateYellowHammerByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 370 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "YellowHammerUpdatableFields": { "Description": [ { "EntryId": 1, "Description": "text" } ], "ErrorMessage": "text", "ExemptServiceCode": 1, "Privilege": [ { "EntryId": 1, "Privilege": 1 } ], "RuleId": [ { "EntryId": 1, "RuleId": 1 } ], "Warning": [ { "EntryId": 1, "Warning": true } ] }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }