CpLetter

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCpLetter

post

Retrieve a CP letter.

Authorizations
Body
CpLetterLetterCodeintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "CpLetter": {
    "Description": "text",
    "LetterCode": 1,
    "NextWorkDays": 1,
    "Specfile": "text"
  }
}

getCpLetterSelectFields

post

Retrieve select fields for a specific CP letter.

Authorizations
Body
CpLetterLetterCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CpLetterLetterCode": 1,
  "SelectableFields": {
    "IncludeAllCpLetterFields": true,
    "CpLetterFields": {
      "Description": true,
      "LetterCode": true,
      "NextWorkDays": true,
      "Specfile": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CpLetter": {
    "Description": "text",
    "LetterCode": 1,
    "NextWorkDays": 1,
    "Specfile": "text"
  }
}

getCpLetterPagedList

post

Retrieve CP letters in a paged list.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getCpLetterPagedList
POST /nexum/627/2022.01/parameter/getCpLetterPagedList 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.

{
  "CpLetter": [
    {
      "Description": "text",
      "LetterCode": 1,
      "NextWorkDays": 1,
      "Specfile": "text"
    }
  ],
  "Token": "text"
}

getCpLetterListSelectFields

post

Retrieve a list of select fields for CP letters.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCpLetterFields": true,
    "CpLetterFields": {
      "Description": true,
      "LetterCode": true,
      "NextWorkDays": true,
      "Specfile": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CpLetterList": {
    "hasReachedMaximumListSize": true,
    "CpLetter": [
      {
        "Description": "text",
        "LetterCode": 1,
        "NextWorkDays": 1,
        "Specfile": "text"
      }
    ]
  }
}

searchCpLetterSelectFields

post

Field for selecting various options related to searchcpletterselectfields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCpLetterFields": true,
    "CpLetterFields": {
      "Description": true,
      "LetterCode": true,
      "NextWorkDays": true,
      "Specfile": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CpLetterList": {
    "hasReachedMaximumListSize": true,
    "CpLetter": [
      {
        "Description": "text",
        "LetterCode": 1,
        "NextWorkDays": 1,
        "Specfile": "text"
      }
    ]
  }
}

getCpLetterPagedListSelectFields

post

Retrieve a paged list of select fields for CP letters.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCpLetterFields": true,
    "CpLetterFields": {
      "Description": true,
      "LetterCode": true,
      "NextWorkDays": true,
      "Specfile": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CpLetter": [
    {
      "Description": "text",
      "LetterCode": 1,
      "NextWorkDays": 1,
      "Specfile": "text"
    }
  ],
  "Token": "text"
}

searchCpLetterPagedSelectFields

post

Field for selecting various options related to searchcpletterpagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCpLetterFields": true,
    "CpLetterFields": {
      "Description": true,
      "LetterCode": true,
      "NextWorkDays": true,
      "Specfile": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CpLetter": [
    {
      "Description": "text",
      "LetterCode": 1,
      "NextWorkDays": 1,
      "Specfile": "text"
    }
  ],
  "Token": "text"
}

updateCpLetterByID

post

Update CP Letter by ID

Authorizations
Body
CpLetterLetterCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CpLetterLetterCode": 1,
  "CpLetterUpdatableFields": {
    "Description": "text",
    "NextWorkDays": 1,
    "Specfile": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?