Get by

GET /action-plan/{taskId}

Path parameters

  • taskId integer Required

Responses

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • id integer
    • dependentSnaps array[object]
      Hide dependentSnaps attributes Show dependentSnaps attributes object
      • id integer
      • actionPlan object
      • dependentActionPlan object
    • parentId integer
    • taskDefinitionId integer
    • period object
      Hide period attributes Show period attributes object
      • id integer
      • name string
      • year string
      • status string

        Values are NOT_STARTED, IN_PROGRESS, COMPLETE, DELETED, or DISABLED.

      • startDate string(date)
      • endDate string(date)
      • closeDayStartDate string(date)
      • closeDayEndDate string(date)
      • completionDate string(date-time)
    • name string
    • number string
    • description string
    • frequency integer
    • status integer(int32)
    • typeId integer
    • taskType integer
    • entity integer
    • entityName string
    • isCollaboration boolean
    • isClosePackage boolean
    • isCritical boolean
    • instructions string
    • assignedDate string(date-time)
    • performerEntityId integer
    • performerEntityName string
    • performerId integer
    • performerGroupId integer
    • performerGroupName string
    • performerIsQueue boolean
    • wasPerformerAssignedQueue boolean
    • dueDate string(date-time)
    • dateCompleted string(date-time)
    • processStatus string
    • reviewer object
      Hide reviewer attributes Show reviewer attributes object
      • id integer
      • firstName string
      • middleInitial string
      • lastName string
      • hrId string
      • userId string
      • title string
      • phone string
      • email string
      • statusId integer
      • ldapGuid string
    • reviewerQueueId integer
    • reviewerQueueName string
    • reviewerDueDate string(date-time)
    • approver object
      Hide approver attributes Show approver attributes object
      • id integer
      • firstName string
      • middleInitial string
      • lastName string
      • hrId string
      • userId string
      • title string
      • phone string
      • email string
      • statusId integer
      • ldapGuid string
    • approverQueueId integer
    • approverQueueName string
    • snapshotTaskTree integer
    • snapshotTaskTreeId integer
    • processSlotCode integer(int32)
    • log object
      Hide log attributes Show log attributes object
      • sid integer
      • formListSid integer
      • reference string
      • routingStatus string
      • slotCode integer(int32)
      • lastRouteTrans integer
      • dueDate string(date-time)
      • isHistoricalAP boolean
      • transactions array[object]
        Hide transactions attributes Show transactions attributes object
        • sid integer
        • log object
        • formListSid integer
        • actionCode string
        • logDate string(date-time)
        • intendedSender string
        • actualSender string
        • receiver string
        • senderTitle string
        • senderSlot integer
        • receiverSlot integer
        • receiverType string
        • receiverProp integer
        • routeType string
        • intendedProp integer
    • isAttachmentRequired boolean
    • responses array[object]
      Hide responses attributes Show responses attributes object
      • responseId integer
      • responseOrder integer(int32)
      • response string
      • question string
      • sourceId integer
      • supportTypeId integer(int32)
      • sourceTypeId integer(int32)
      • explanation string
      • acctTypeId integer(int32)
      • responseTypeId integer(int32)
    • closeTaskRole string

      Values are PERFORMER, REVIEWER, or APPROVER.

GET /action-plan/{taskId}
curl \
 --request GET 'https://customer.trintech.com/action-plan/{taskId}'
Response examples (200)
{
  "id": 42,
  "dependentSnaps": [
    {
      "id": 42,
      "actionPlan": {},
      "dependentActionPlan": {}
    }
  ],
  "parentId": 42,
  "taskDefinitionId": 42,
  "period": "{\n    \"id\": 37,\n    \"name\": \"Sep\",\n    \"year\": \"2018\",\n    \"status\": \"IN_PROGRESS\",\n    \"startDate\": \"2017-09-01\",\n    \"endDate\": \"2017-09-30\",\n    \"closeDayStartDate\": \"2017-09-01\",\n    \"closeDayEndDate\": \"2017-09-30,\n    \"completionDate\": null\n}\n",
  "name": "string",
  "number": "string",
  "description": "string",
  "frequency": 42,
  "status": 42,
  "typeId": 42,
  "taskType": 42,
  "entity": 42,
  "entityName": "string",
  "isCollaboration": true,
  "isClosePackage": true,
  "isCritical": true,
  "instructions": "string",
  "assignedDate": "2025-05-04T09:42:00Z",
  "performerEntityId": 42,
  "performerEntityName": "string",
  "performerId": 42,
  "performerGroupId": 42,
  "performerGroupName": "string",
  "performerIsQueue": true,
  "wasPerformerAssignedQueue": true,
  "dueDate": "2025-05-04T09:42:00Z",
  "dateCompleted": "2025-05-04T09:42:00Z",
  "processStatus": "string",
  "reviewer": {
    "id": 42,
    "firstName": "string",
    "middleInitial": "string",
    "lastName": "string",
    "hrId": "string",
    "userId": "string",
    "title": "string",
    "phone": "string",
    "email": "string",
    "statusId": 42,
    "ldapGuid": "string"
  },
  "reviewerQueueId": 42,
  "reviewerQueueName": "string",
  "reviewerDueDate": "2025-05-04T09:42:00Z",
  "approver": {
    "id": 42,
    "firstName": "string",
    "middleInitial": "string",
    "lastName": "string",
    "hrId": "string",
    "userId": "string",
    "title": "string",
    "phone": "string",
    "email": "string",
    "statusId": 42,
    "ldapGuid": "string"
  },
  "approverQueueId": 42,
  "approverQueueName": "string",
  "snapshotTaskTree": 42,
  "snapshotTaskTreeId": 42,
  "processSlotCode": 42,
  "log": {
    "sid": 42,
    "formListSid": 42,
    "reference": "string",
    "routingStatus": "string",
    "slotCode": 42,
    "lastRouteTrans": 42,
    "dueDate": "2025-05-04T09:42:00Z",
    "isHistoricalAP": true,
    "transactions": [
      {
        "sid": 42,
        "log": {},
        "formListSid": 42,
        "actionCode": "string",
        "logDate": "2025-05-04T09:42:00Z",
        "intendedSender": "string",
        "actualSender": "string",
        "receiver": "string",
        "senderTitle": "string",
        "senderSlot": 42,
        "receiverSlot": 42,
        "receiverType": "string",
        "receiverProp": 42,
        "routeType": "string",
        "intendedProp": 42
      }
    ]
  },
  "isAttachmentRequired": true,
  "responses": [
    {
      "responseId": 42,
      "responseOrder": 42,
      "response": "string",
      "question": "string",
      "sourceId": 42,
      "supportTypeId": 42,
      "sourceTypeId": 42,
      "explanation": "string",
      "acctTypeId": 42,
      "responseTypeId": 42
    }
  ],
  "closeTaskRole": "PERFORMER"
}