CheckService

Manage checks.

Symitar eDocs References: Coming soon.

Operations

getCheck

post

Retrieves a check.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post/getCheck

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Check": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCheck"
}

getCheckSelectFields

post

Retrieves a check with selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post/getCheckSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllCheckFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Check": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCheckSelectFields"
}

getCheckSelectFieldsFilterChildren

post

Retrieves a check with selected fields and filtered children.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post/getCheckSelectFieldsFilterChildren

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllCheckFields": true
  },
  "ChildrenSearchFilter": {
    "CheckFmHistoryFilter": {
      "Query": "example-query"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Check": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCheckSelectFieldsFilterChildren"
}

getCheckFmHistoryPagedList

post

Retrieves a paged list of check FM history.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCheckFmHistoryPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CheckFmHistory": [],
  "Token": null,
  "MessageId": "getCheckFmHistoryPagedList"
}

getCheckFmHistoryListSelectFields

post

Retrieves a list of check FM history with selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post/getCheckFmHistoryListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CheckFmHistoryList": [],
  "MessageId": "getCheckFmHistoryListSelectFields"
}

searchCheckFmHistorySelectFields

post

Searches check FM history with selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post/searchCheckFmHistorySelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CheckFmHistoryList": [],
  "MessageId": "searchCheckFmHistorySelectFields"
}

getCheckFmHistoryPagedListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCheckFmHistoryPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CheckFmHistory": [],
  "Token": null,
  "MessageId": "getCheckFmHistoryPagedListSelectFields"
}

searchCheckFmHistoryPagedSelectFields

post

Searches check FM history with pagination and selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchCheckFmHistoryPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true
  },
  "Query": "example-query",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CheckFmHistory": [],
  "Token": null,
  "MessageId": "searchCheckFmHistoryPagedSelectFields"
}

updateCheckByID

post

Updates a check by ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post/updateCheckByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "CheckUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateCheckByID"
}

createCheck

post

Creates a new check.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/createCheck

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckCreatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CheckCompositeKey": "example-value",
  "MessageId": "createCheck"
}

deleteCheck

post

Deletes a check.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteCheck

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CheckGlobalSequenceDate": "2010-05-08",
  "CheckGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {},
  "MessageId": "deleteCheck"
}