Update schedule

POST /closeAPI/api/close/task/{id}/schedule

Path parameters

id integer Required

application/json

Body Required

frequencyId integer
startDayId integer
startOffset integer(int32)
dueDayId integer
dueMinutes integer
reviewerDueDayId integer
reviewerDueMinutes integer
approverDueDayId integer
approverDueMinutes integer
instructions string
assignmentUpdates object
Hide assignmentUpdates attributes Show assignmentUpdates attributes object
- performers array[object]
  Hide performers attributes Show performers attributes object
  
  id integer
  
  name string
  
  type string
  
  Values are PEOPLE, GROUP, or QUEUE.
  
  email string
  
  entityId integer
- removePerformers array[object]
  Hide removePerformers attributes Show removePerformers attributes object
  
  id integer
  
  name string
  
  email string
  
  type string
  
  Values are PEOPLE, GROUP, or QUEUE.
  
  delete boolean
- performer object
  Hide performer attributes Show performer attributes object
  
  id integer
  
  name string
  
  email string
  
  type string
  
  Values are PEOPLE, GROUP, or QUEUE.
  
  delete boolean
- reviewer object
  Hide reviewer attributes Show reviewer attributes object
  
  id integer
  
  name string
  
  email string
  
  type string
  
  Values are PEOPLE, GROUP, or QUEUE.
  
  delete boolean
- approver object
  Hide approver attributes Show approver attributes object
  
  id integer
  
  name string
  
  email string
  
  type string
  
  Values are PEOPLE, GROUP, or QUEUE.
  
  delete boolean
- escalator object
  Hide escalator attributes Show escalator attributes object
  
  id integer
  
  name string
  
  email string
  
  type string
  
  Values are PEOPLE, GROUP, or QUEUE.
  
  delete boolean
sameUserConfirmed boolean

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id integer
- parentId integer
- name string
- number string
- description string
- frequencyId integer
- frequencyName string
- status string
  
  Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.
- type string
  
  Values are ENTITY, CLOSE_TASK, or RECON_TASK.
- entityId integer
- entityName string
- isCollaboration boolean
- isCritical boolean
- isClosePackage boolean
- taskTypeId integer
- taskTypeName string
- isAttachmentRequired boolean
- userDefinedFields array[object]
  
  Hide userDefinedFields attributes Show userDefinedFields attributes object
  
  id integer
  
  udfDefinitionId integer
  
  value string

POST /closeAPI/api/close/task/{id}/schedule

curl \
 --request POST 'http://close-service:8082/closeAPI/api/close/task/{id}/schedule' \
 --header "Content-Type: application/json" \
 --data '{"frequencyId":42,"startDayId":42,"startOffset":42,"dueDayId":42,"dueMinutes":42,"reviewerDueDayId":42,"reviewerDueMinutes":42,"approverDueDayId":42,"approverDueMinutes":42,"instructions":"string","assignmentUpdates":{"performers":[{"id":42,"name":"string","type":"PEOPLE","email":"string","entityId":42}],"removePerformers":[{"id":42,"name":"string","email":"string","type":"PEOPLE","delete":true}],"performer":{"id":42,"name":"string","email":"string","type":"PEOPLE","delete":true},"reviewer":{"id":42,"name":"string","email":"string","type":"PEOPLE","delete":true},"approver":{"id":42,"name":"string","email":"string","type":"PEOPLE","delete":true},"escalator":{"id":42,"name":"string","email":"string","type":"PEOPLE","delete":true}},"sameUserConfirmed":true}'

Request examples

{
  "frequencyId": 42,
  "startDayId": 42,
  "startOffset": 42,
  "dueDayId": 42,
  "dueMinutes": 42,
  "reviewerDueDayId": 42,
  "reviewerDueMinutes": 42,
  "approverDueDayId": 42,
  "approverDueMinutes": 42,
  "instructions": "string",
  "assignmentUpdates": {
    "performers": [
      {
        "id": 42,
        "name": "string",
        "type": "PEOPLE",
        "email": "string",
        "entityId": 42
      }
    ],
    "removePerformers": [
      {
        "id": 42,
        "name": "string",
        "email": "string",
        "type": "PEOPLE",
        "delete": true
      }
    ],
    "performer": {
      "id": 42,
      "name": "string",
      "email": "string",
      "type": "PEOPLE",
      "delete": true
    },
    "reviewer": {
      "id": 42,
      "name": "string",
      "email": "string",
      "type": "PEOPLE",
      "delete": true
    },
    "approver": {
      "id": 42,
      "name": "string",
      "email": "string",
      "type": "PEOPLE",
      "delete": true
    },
    "escalator": {
      "id": 42,
      "name": "string",
      "email": "string",
      "type": "PEOPLE",
      "delete": true
    }
  },
  "sameUserConfirmed": true
}

Response examples (200)

{
  "id": 42,
  "parentId": 42,
  "name": "string",
  "number": "string",
  "description": "string",
  "frequencyId": 42,
  "frequencyName": "string",
  "status": "ACTIVE",
  "type": "ENTITY",
  "entityId": 42,
  "entityName": "string",
  "isCollaboration": true,
  "isCritical": true,
  "isClosePackage": true,
  "taskTypeId": 42,
  "taskTypeName": "string",
  "isAttachmentRequired": true,
  "userDefinedFields": [
    {
      "id": 42,
      "udfDefinitionId": 42,
      "value": "string"
    }
  ]
}