CheckService

Manage checks.

Symitar eDocs References: Coming soon.

Operations

getCheck

post

Retrieves a check.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getCheck
200

Successful operation.

getCheckSelectFields

post

Retrieves a check with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getCheckSelectFields
200

Successful operation.

getCheckSelectFieldsFilterChildren

post

Retrieves a check with selected fields and filtered children.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getCheckSelectFieldsFilterChildren
200

Successful operation.

getCheckFmHistoryPagedList

post

Retrieves a paged list of check FM history.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getCheckFmHistoryPagedList
200

Successful operation.

getCheckFmHistoryListSelectFields

post

Retrieves a list of check FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getCheckFmHistoryListSelectFields
200

Successful operation.

searchCheckFmHistorySelectFields

post

Searches check FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/searchCheckFmHistorySelectFields
200

Successful operation.

getCheckFmHistoryPagedListSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getCheckFmHistoryPagedListSelectFields
200

Successful operation.

searchCheckFmHistoryPagedSelectFields

post

Searches check FM history with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchCheckFmHistoryPagedSelectFields
200

Successful operation.

updateCheckByID

post

Updates a check by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/updateCheckByID
200

Successful operation.

createCheck

post

Creates a new check.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
post
/createCheck
200

Successful operation.

deleteCheck

post

Deletes a check.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CheckGlobalSequenceDatestring · dateOptional
CheckGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/deleteCheck
200

Successful operation.

Last updated

Was this helpful?