Skip to content
NexumAPI Docs

CheckService⁠

Manage checks.

Operations⁠

getCheckSelectFields⁠

POST

Retrieves a check with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CheckGlobalSequenceDatestring · dateoptional
CheckGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/check/getCheckSelectFields
POST /nexum/627/persistent/check/getCheckSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2026-01-01",
  "CheckGlobalSequence": 0,
  "SelectableFields": {
    "IncludeAllCheckFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getCheckSelectFieldsFilterChildren⁠

POST

Retrieves a check with selected fields and filtered children.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CheckGlobalSequenceDatestring · dateoptional
CheckGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/check/getCheckSelectFieldsFilterChildren
POST /nexum/627/persistent/check/getCheckSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2026-01-01",
  "CheckGlobalSequence": 0,
  "SelectableFields": {
    "IncludeAllCheckFields": true
  },
  "ChildrenSearchFilter": {
    "CheckFmHistoryFilter": {
      "StartPostDate": "2026-01-01",
      "EndPostDate": "2026-01-01",
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getCheckFmHistoryPagedListSelectFields⁠

POST

Retrieves a paged list of check FM history with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CheckGlobalSequenceDatestring · dateoptional
CheckGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/persistent/check/getCheckFmHistoryPagedListSelectFields
POST /nexum/627/persistent/check/getCheckFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2026-01-01",
  "CheckGlobalSequence": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "REPLACE_WITH_YOUR_TOKEN"
  },
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchCheckFmHistoryPagedSelectFields⁠

POST

Searches check FM history with pagination and selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CheckGlobalSequenceDatestring · dateoptional
CheckGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/persistent/check/searchCheckFmHistoryPagedSelectFields
POST /nexum/627/persistent/check/searchCheckFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2026-01-01",
  "CheckGlobalSequence": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "REPLACE_WITH_YOUR_TOKEN"
  },
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true
  },
  "SearchFilter": {
    "StartPostDate": "2026-01-01",
    "EndPostDate": "2026-01-01",
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateCheckByID⁠

POST

Updates a check by ID.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CheckGlobalSequenceDatestring · dateoptional
CheckGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/check/updateCheckByID
POST /nexum/627/persistent/check/updateCheckByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2026-01-01",
  "CheckGlobalSequence": 0,
  "CheckFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createCheck⁠

POST

Creates a new check.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/check/createCheck
POST /nexum/627/persistent/check/createCheck HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}