Last updated 10 months ago
Was this helpful?
Perform various operations on comment records.
Symitar eDocs References: Coming soon.
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.
{"UserNumberCredentials":{"UserNumber":1995,"Password":"2dfKQYR!TeXJwe"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/account/getComment HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 181 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "CommentLocator": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "Comment": { "EffectiveDate": "2025-05-19", "ExpirationDate": "2025-05-19", "Locator": 1, "RecordChangeDate": "2025-05-19", "Text": "text", "Type": 1 } }
POST /nexum/627/2022.01/account/getCommentSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 357 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "CommentLocator": 1, "SelectableFields": { "IncludeAllCommentFields": true, "CommentFields": { "EffectiveDate": true, "ExpirationDate": true, "Locator": true, "RecordChangeDate": true, "Text": true, "Type": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/getCommentPagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 256 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "Comment": [ { "EffectiveDate": "2025-05-19", "ExpirationDate": "2025-05-19", "Locator": 1, "RecordChangeDate": "2025-05-19", "Text": "text", "Type": 1 } ], "Token": "text" }
POST /nexum/627/2022.01/account/getCommentListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 338 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "SelectableFields": { "IncludeAllCommentFields": true, "CommentFields": { "EffectiveDate": true, "ExpirationDate": true, "Locator": true, "RecordChangeDate": true, "Text": true, "Type": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "CommentList": { "hasReachedMaximumListSize": true, "Comment": [ { "EffectiveDate": "2025-05-19", "ExpirationDate": "2025-05-19", "Locator": 1, "RecordChangeDate": "2025-05-19", "Text": "text", "Type": 1 } ] } }
POST /nexum/627/2022.01/account/searchCommentSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 370 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "SelectableFields": { "IncludeAllCommentFields": true, "CommentFields": { "EffectiveDate": true, "ExpirationDate": true, "Locator": true, "RecordChangeDate": true, "Text": true, "Type": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/getCommentPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 432 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllCommentFields": true, "CommentFields": { "EffectiveDate": true, "ExpirationDate": true, "Locator": true, "RecordChangeDate": true, "Text": true, "Type": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/searchCommentPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 447 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllCommentFields": true, "CommentFields": { "EffectiveDate": true, "ExpirationDate": true, "Locator": true, "RecordChangeDate": true, "Text": true, "Type": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/updateCommentByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 290 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "CommentLocator": 1, "CommentUpdatableFields": { "EffectiveDate": "2025-05-19", "ExpirationDate": "2025-05-19", "Text": "text", "Type": 1 }, "AccountNumber": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
POST /nexum/627/2022.01/account/createComment HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 271 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "CommentCreatableFields": { "EffectiveDate": "2025-05-19", "ExpirationDate": "2025-05-19", "Text": "text", "Type": 1 }, "AccountNumber": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "CommentLocator": 1 }
POST /nexum/627/2022.01/account/deleteComment HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 181 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "CommentLocator": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "nxAttributes": {} }
