Comment

Perform various operations on comment records.

Symitar eDocs References: Coming soon.

Operations

getComment

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

CommentLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getComment

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getComment HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "CommentLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Comment": {
    "EffectiveDate": "2026-03-26",
    "ExpirationDate": "2026-03-26",
    "Locator": 1,
    "RecordChangeDate": "2026-03-26",
    "Text": "text",
    "Type": 1
  }
}

getCommentSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

CommentLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getCommentSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getCommentSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "Comment": {
    "EffectiveDate": "2026-03-26",
    "ExpirationDate": "2026-03-26",
    "Locator": 1,
    "RecordChangeDate": "2026-03-26",
    "Text": "text",
    "Type": 1
  }
}

getCommentPagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/getCommentPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getCommentPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "Comment": [
    {
      "EffectiveDate": "2026-03-26",
      "ExpirationDate": "2026-03-26",
      "Locator": 1,
      "RecordChangeDate": "2026-03-26",
      "Text": "text",
      "Type": 1
    }
  ],
  "Token": "text"
}

getCommentListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getCommentListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getCommentListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "CommentList": {
    "hasReachedMaximumListSize": true,
    "Comment": [
      {
        "EffectiveDate": "2026-03-26",
        "ExpirationDate": "2026-03-26",
        "Locator": 1,
        "RecordChangeDate": "2026-03-26",
        "Text": "text",
        "Type": 1
      }
    ]
  }
}

searchCommentSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/searchCommentSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchCommentSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "CommentList": {
    "hasReachedMaximumListSize": true,
    "Comment": [
      {
        "EffectiveDate": "2026-03-26",
        "ExpirationDate": "2026-03-26",
        "Locator": 1,
        "RecordChangeDate": "2026-03-26",
        "Text": "text",
        "Type": 1
      }
    ]
  }
}

getCommentPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/getCommentPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getCommentPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "Comment": [
    {
      "EffectiveDate": "2026-03-26",
      "ExpirationDate": "2026-03-26",
      "Locator": 1,
      "RecordChangeDate": "2026-03-26",
      "Text": "text",
      "Type": 1
    }
  ],
  "Token": "text"
}

searchCommentPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/searchCommentPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchCommentPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "Comment": [
    {
      "EffectiveDate": "2026-03-26",
      "ExpirationDate": "2026-03-26",
      "Locator": 1,
      "RecordChangeDate": "2026-03-26",
      "Text": "text",
      "Type": 1
    }
  ],
  "Token": "text"
}

updateCommentByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CommentLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/updateCommentByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/updateCommentByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "CommentLocator": 1,
  "CommentUpdatableFields": {
    "EffectiveDate": "2026-03-26",
    "ExpirationDate": "2026-03-26",
    "Text": "text",
    "Type": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

createComment

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

CommentLocatorintegerOptional

post

/createComment

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/createComment HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "CommentCreatableFields": {
    "EffectiveDate": "2026-03-26",
    "ExpirationDate": "2026-03-26",
    "Text": "text",
    "Type": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CommentLocator": 1
}

deleteComment

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

CommentLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post

/deleteComment

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/deleteComment HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "CommentLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}