DocTypeDefault

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDocTypeDefault

post

Retrieve default document type data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

DocTypeDefaultDocumentTypeintegerRequired

Responses

200

Successful operation.

application/json

post

/getDocTypeDefault

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DocTypeDefaultDocumentType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocTypeDefault": {
    "Description": "text",
    "DocumentType": 1,
    "ExcpNoticeCountCpWork": 1,
    "ExcpNoticeOption": 1,
    "ExpireDate": "2025-12-25",
    "Type": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserChar5": "text",
    "UserChar6": "text"
  }
}

getDocTypeDefaultSelectFields

post

Retrieve select fields for default document type data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

DocTypeDefaultDocumentTypeintegerOptional

Responses

200

Successful operation.

application/json

post

/getDocTypeDefaultSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DocTypeDefaultDocumentType": 1,
  "SelectableFields": {
    "IncludeAllDocTypeDefaultFields": true,
    "DocTypeDefaultFields": {
      "Description": true,
      "DocumentType": true,
      "ExcpNoticeCountCpWork": true,
      "ExcpNoticeOption": true,
      "ExpireDate": true,
      "Type": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserChar5": true,
      "UserChar6": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocTypeDefault": {
    "Description": "text",
    "DocumentType": 1,
    "ExcpNoticeCountCpWork": 1,
    "ExcpNoticeOption": 1,
    "ExpireDate": "2025-12-25",
    "Type": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserChar5": "text",
    "UserChar6": "text"
  }
}

getDocTypeDefaultPagedList

post

Retrieve paged default document type data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getDocTypeDefaultPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocTypeDefault": [
    {
      "Description": "text",
      "DocumentType": 1,
      "ExcpNoticeCountCpWork": 1,
      "ExcpNoticeOption": 1,
      "ExpireDate": "2025-12-25",
      "Type": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserChar4": "text",
      "UserChar5": "text",
      "UserChar6": "text"
    }
  ],
  "Token": "text"
}

getDocTypeDefaultListSelectFields

post

Retrieve select fields for a list of default document type data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getDocTypeDefaultListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllDocTypeDefaultFields": true,
    "DocTypeDefaultFields": {
      "Description": true,
      "DocumentType": true,
      "ExcpNoticeCountCpWork": true,
      "ExcpNoticeOption": true,
      "ExpireDate": true,
      "Type": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserChar5": true,
      "UserChar6": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocTypeDefaultList": {
    "hasReachedMaximumListSize": true,
    "DocTypeDefault": [
      {
        "Description": "text",
        "DocumentType": 1,
        "ExcpNoticeCountCpWork": 1,
        "ExcpNoticeOption": 1,
        "ExpireDate": "2025-12-25",
        "Type": 1,
        "UserChar1": "text",
        "UserChar2": "text",
        "UserChar3": "text",
        "UserChar4": "text",
        "UserChar5": "text",
        "UserChar6": "text"
      }
    ]
  }
}

searchDocTypeDefaultSelectFields

post

Field for selecting various options related to searchdoctypedefaultselectfields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/searchDocTypeDefaultSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllDocTypeDefaultFields": true,
    "DocTypeDefaultFields": {
      "Description": true,
      "DocumentType": true,
      "ExcpNoticeCountCpWork": true,
      "ExcpNoticeOption": true,
      "ExpireDate": true,
      "Type": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserChar5": true,
      "UserChar6": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocTypeDefaultList": {
    "hasReachedMaximumListSize": true,
    "DocTypeDefault": [
      {
        "Description": "text",
        "DocumentType": 1,
        "ExcpNoticeCountCpWork": 1,
        "ExcpNoticeOption": 1,
        "ExpireDate": "2025-12-25",
        "Type": 1,
        "UserChar1": "text",
        "UserChar2": "text",
        "UserChar3": "text",
        "UserChar4": "text",
        "UserChar5": "text",
        "UserChar6": "text"
      }
    ]
  }
}

getDocTypeDefaultPagedListSelectFields

post

Retrieve select fields for paged default document type data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getDocTypeDefaultPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllDocTypeDefaultFields": true,
    "DocTypeDefaultFields": {
      "Description": true,
      "DocumentType": true,
      "ExcpNoticeCountCpWork": true,
      "ExcpNoticeOption": true,
      "ExpireDate": true,
      "Type": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserChar5": true,
      "UserChar6": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocTypeDefault": [
    {
      "Description": "text",
      "DocumentType": 1,
      "ExcpNoticeCountCpWork": 1,
      "ExcpNoticeOption": 1,
      "ExpireDate": "2025-12-25",
      "Type": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserChar4": "text",
      "UserChar5": "text",
      "UserChar6": "text"
    }
  ],
  "Token": "text"
}

searchDocTypeDefaultPagedSelectFields

post

Field for selecting various options related to searchdoctypedefaultpagedselectfields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchDocTypeDefaultPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllDocTypeDefaultFields": true,
    "DocTypeDefaultFields": {
      "Description": true,
      "DocumentType": true,
      "ExcpNoticeCountCpWork": true,
      "ExcpNoticeOption": true,
      "ExpireDate": true,
      "Type": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserChar5": true,
      "UserChar6": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "DocTypeDefault": [
    {
      "Description": "text",
      "DocumentType": 1,
      "ExcpNoticeCountCpWork": 1,
      "ExcpNoticeOption": 1,
      "ExpireDate": "2025-12-25",
      "Type": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserChar4": "text",
      "UserChar5": "text",
      "UserChar6": "text"
    }
  ],
  "Token": "text"
}

updateDocTypeDefaultByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

DocTypeDefaultDocumentTypeintegerOptional

Responses

200

Successful operation.

application/json

post

/updateDocTypeDefaultByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DocTypeDefaultDocumentType": 1,
  "DocTypeDefaultUpdatableFields": {
    "Description": "text",
    "ExcpNoticeCountCpWork": 1,
    "ExcpNoticeOption": 1,
    "ExpireDate": "2025-12-25",
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserChar5": "text",
    "UserChar6": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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