Submit a single task for update

PATCH /cs-close-api/tasks/{id}
Oidc Oauth2

Submit a single task from the close task detail for APPROVE or REOPEN.

Path parameters

  • id integer Required

    The identifier of task for update.

application/json

Body Required

  • action string Required

    The submit action. One of 'APPROVE' or 'REOPEN'.

    Values are APPROVE, CANCEL, SUBMIT, REJECT, RESUBMIT, REOPEN, TRANSFER, INVALIDATE, CC, or NOTIFY.

  • actionPlanId integer

    The identifier of the task being submitted. One of actionPlanId or taskNumber and period is required.

  • taskNumber string Deprecated

    The number of the task being submitted. One of actionPlanId or taskNumber and period is required. Deprecated, use actionPlanId

    Minimum length is 0, maximum length is 128.

  • periodId integer Deprecated

    The identifier of period. Required when using the taskNumber as the identifier, otherwise ignored. Deprecated, use actionPlanId

  • fiscalYearName string Deprecated

    The name of the fiscal year for the task. Required when using the taskNumber as the identifier and periodId is not provided. Deprecated, use actionPlanId

    Minimum length is 0, maximum length is 20.

  • fiscalPeriodName string Deprecated

    The name of the fiscal period for the task. Required when using the taskNumber as the identifier and periodId is not provided. Deprecated, use actionPlanId

    Minimum length is 0, maximum length is 20.

  • saveSubmitComment boolean Required

    If true, sumbit comment is required and will be saved along with the task.

  • submitComment string Required

    The additional comment made by the submitter. Optional. If provided it will be included in the email to the receiver.

    Minimum length is 0, maximum length is 2048.

  • performerComment string Required

    The comment made by the performer on the close task detail.

    Minimum length is 0, maximum length is 2048.

  • reviewerComment string Required

    The comment made by the reviewer on the close task detail.

    Minimum length is 0, maximum length is 2048.

  • approverComment string Required

    The comment made by the approver on the close task detail.

    Minimum length is 0, maximum length is 2048.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • success boolean
    • id string
    • message string
PATCH /cs-close-api/tasks/{id} 
curl \
 --request PATCH 'https://customer.trintech.com/cs-close-api/tasks/{id}' \
 --header "Content-Type: application/json" \
 --data '{"action":"APPROVE","actionPlanId":42,"taskNumber":"string","periodId":42,"fiscalYearName":"string","fiscalPeriodName":"string","saveSubmitComment":true,"submitComment":"string","performerComment":"string","reviewerComment":"string","approverComment":"string"}'
Request examples 
{
  "action": "APPROVE",
  "actionPlanId": 42,
  "taskNumber": "string",
  "periodId": 42,
  "fiscalYearName": "string",
  "fiscalPeriodName": "string",
  "saveSubmitComment": true,
  "submitComment": "string",
  "performerComment": "string",
  "reviewerComment": "string",
  "approverComment": "string"
}
Response examples (200) 
{
  "success": true,
  "id": "string",
  "message": "string"
}