CpWorkCard

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCpWorkCard

post

Retrieve CP work card information.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getCpWorkCard

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CpWorkCard": {
    "AdditionalInfoHeader": [
      {
        "EntryId": 1,
        "AdditionalInfoHeader": "text"
      }
    ],
    "AdditionalInfoJustify": [
      {
        "EntryId": 1,
        "AdditionalInfoJustify": 1
      }
    ],
    "AdditionalInfoSpecfileName": "text",
    "AutomaticAdvanceNextQueued": 1,
    "CollectionQueueUserDisplay": 1,
    "NextWorkDateMaxAdvance": 1,
    "WorkCardDescriptionType": [
      {
        "EntryId": 1,
        "WorkCardDescriptionType": "text"
      }
    ]
  }
}

getCpWorkCardSelectFields

post

Retrieve select fields for CP work card information.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getCpWorkCardSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCpWorkCardFields": true,
    "CpWorkCardFields": {
      "AdditionalInfoHeader": [
        1
      ],
      "AdditionalInfoJustify": [
        1
      ],
      "AdditionalInfoSpecfileName": true,
      "AutomaticAdvanceNextQueued": true,
      "CollectionQueueUserDisplay": true,
      "NextWorkDateMaxAdvance": true,
      "WorkCardDescriptionType": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CpWorkCard": {
    "AdditionalInfoHeader": [
      {
        "EntryId": 1,
        "AdditionalInfoHeader": "text"
      }
    ],
    "AdditionalInfoJustify": [
      {
        "EntryId": 1,
        "AdditionalInfoJustify": 1
      }
    ],
    "AdditionalInfoSpecfileName": "text",
    "AutomaticAdvanceNextQueued": 1,
    "CollectionQueueUserDisplay": 1,
    "NextWorkDateMaxAdvance": 1,
    "WorkCardDescriptionType": [
      {
        "EntryId": 1,
        "WorkCardDescriptionType": "text"
      }
    ]
  }
}

updateCpWorkCardByID

post

Update CP Work Card by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/updateCpWorkCardByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CpWorkCardUpdatableFields": {
    "AdditionalInfoHeader": [
      {
        "EntryId": 1,
        "AdditionalInfoHeader": "text"
      }
    ],
    "AdditionalInfoJustify": [
      {
        "EntryId": 1,
        "AdditionalInfoJustify": 1
      }
    ],
    "AdditionalInfoSpecfileName": "text",
    "AutomaticAdvanceNextQueued": 1,
    "CollectionQueueUserDisplay": 1,
    "NextWorkDateMaxAdvance": 1,
    "WorkCardDescriptionType": [
      {
        "EntryId": 1,
        "WorkCardDescriptionType": "text"
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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