Jump to

• Request
• Response

Create a checklist assignment

post

/fscmRestApi/resources/11.13.18.05/hedChecklistAssignments

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssigneePartyId: integer (int64)
  Title: Checklist Assignee Party Identifier

  Party assigned to the checklist.
• AssociatedPartyId: integer (int64)
  Title: Checklist Assignment Associated Party Identifier

  Party identifier associated with the checklist.
• ChecklistId(required): integer (int64)
  Title: Checklist Setup Identifier

  Unique identifier for the checklist.
• checklistTaskAssignments: array Checklist Task Assignments
  Title: Checklist Task Assignments

  The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.
• CompleteFlag: boolean
  Title: Checklist Complete

  Maximum Length: 1

  Default Value: false

  Indicates whether the task is completed.
• DueDate: string (date-time)
  Title: Checklist Due Date

  Due date.
• InstitutionId: integer (int64)
  Unique identifier for institution.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  Name of institution.
• NotifyAssignedFlag(required): boolean
  Maximum Length: 1

  Indicates to the user whether the assignee should receive a communication when the task is assigned.
• NotifyCompletedFlag(required): boolean
  Maximum Length: 1

  Indicates to the user whether the assignee receives a communication upon completion of the task.
• NotifyDueFlag(required): boolean
  Maximum Length: 1

  Indicates to the user whether the assignee receives a communication when the task is due.
• ReassignmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Allow reassignment.
• SourceObjectCode: string
  Title: Business Process Source Code

  Maximum Length: 50

  Code for source object.
• SourceObjectId: integer (int64)
  Title: Business Process Source Identifier

  Unique identifier for source object.

{
    "required":[
        "ChecklistId",
        "NotifyAssignedFlag",
        "NotifyCompletedFlag",
        "NotifyDueFlag"
    ],
    "type":"object",
    "properties":{
        "ReassignmentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Allow reassignment.",
            "nullable":false,
            "default":false
        },
        "NotifyCompletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication upon completion of the task.",
            "nullable":false
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"Name of institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstitutionId":{
            "type":"integer",
            "description":"Unique identifier for institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyAssignedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee should receive a communication when the task is assigned.",
            "nullable":false
        },
        "ChecklistId":{
            "title":"Checklist Setup Identifier",
            "type":"integer",
            "description":"Unique identifier for the checklist.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CompleteFlag":{
            "title":"Checklist Complete",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the task is completed.",
            "nullable":false,
            "default":false
        },
        "SourceObjectId":{
            "title":"Business Process Source Identifier",
            "type":"integer",
            "description":"Unique identifier for source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyDueFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication when the task is due.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Business Process Source Code",
            "maxLength":"50",
            "type":"string",
            "description":"Code for source object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "checklistTaskAssignments":{
            "title":"Checklist Task Assignments",
            "type":"array",
            "description":"The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.",
            "items":{
                "$ref":"#/components/schemas/hedChecklistAssignments-checklistTaskAssignments-item-post-request"
            }
        },
        "DueDate":{
            "title":"Checklist Due Date",
            "type":"string",
            "description":"Due date.",
            "format":"date-time",
            "nullable":true
        },
        "AssigneePartyId":{
            "title":"Checklist Assignee Party Identifier",
            "type":"integer",
            "description":"Party assigned to the checklist.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssociatedPartyId":{
            "title":"Checklist Assignment Associated Party Identifier",
            "type":"integer",
            "description":"Party identifier associated with the checklist.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Checklist Task Assignments

Type: array

Title: Checklist Task Assignments

The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.

Show Source

• Array of: object hedChecklistAssignments-checklistTaskAssignments-item-post-request

{
    "title":"Checklist Task Assignments",
    "type":"array",
    "description":"The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.",
    "items":{
        "$ref":"#/components/schemas/hedChecklistAssignments-checklistTaskAssignments-item-post-request"
    }
}

Nested Schema : hedChecklistAssignments-checklistTaskAssignments-item-post-request

Type: object

Show Source

• DueDate: string (date-time)
  Title: Task Assignment Due Date

  Due date.
• NotifyAssignedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee should receive a communication when the task is assigned.
• NotifyCompletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication upon completion of the task.
• NotifyDueFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication when the task is due.
• StarredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.
• StatusCode: string
  Title: Task Outcome Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_STATUS_IN_PROGRESS

  Status code.
• TaskId: integer (int64)
  Title: Task Identifier

  Unique identifier for the task.

{
    "type":"object",
    "properties":{
        "NotifyCompletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication upon completion of the task.",
            "nullable":false,
            "default":false
        },
        "TaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"Unique identifier for the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyDueFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication when the task is due.",
            "nullable":false,
            "default":false
        },
        "NotifyAssignedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee should receive a communication when the task is assigned.",
            "nullable":false,
            "default":false
        },
        "StarredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.",
            "nullable":false,
            "default":false
        },
        "DueDate":{
            "title":"Task Assignment Due Date",
            "type":"string",
            "description":"Due date.",
            "format":"date-time",
            "nullable":true
        },
        "StatusCode":{
            "title":"Task Outcome Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code.",
            "nullable":false,
            "default":"ORA_HEY_STATUS_IN_PROGRESS",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedChecklistAssignments-item-response

Type: object

Show Source

• AssigneeEmail: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Preferred email of party assigned to the checklist.
• AssigneeFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First name of party assigned to the checklist.
• AssigneeLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last name of party assigned to the checklist.
• AssigneeName: string
  Title: Assignee

  Read Only: true

  Maximum Length: 450

  Name of party assigned to the checklist.
• AssigneePartyId: integer (int64)
  Title: Checklist Assignee Party Identifier

  Party assigned to the checklist.
• AssociatedPartyId: integer (int64)
  Title: Checklist Assignment Associated Party Identifier

  Party identifier associated with the checklist.
• AssociatedPersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First name of party associated with the checklist.
• AssociatedPersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last name of party associated with the checklist.
• AssociatedPersonName: string
  Title: Associated Person

  Read Only: true

  Maximum Length: 450

  Name of party associated with the checklist.
• CategoryId: integer (int64)
  Title: Checklist Category Identifier

  Read Only: true

  Unique identifier for checklist category.
• CategoryName: string
  Read Only: true

  Maximum Length: 50

  Name of checklist category.
• ChecklistAssignmentId: integer (int64)
  Title: Checklist Assignment Identifier

  Read Only: true

  Unique identifier for an instance of checklist assignment.
• ChecklistAssignmentURL: string
  Read Only: true

  URL for checklist assignment.
• ChecklistCode: string
  Title: Checklist Code

  Read Only: true

  Maximum Length: 50

  Code for checklist.
• ChecklistId: integer (int64)
  Title: Checklist Setup Identifier

  Unique identifier for the checklist.
• ChecklistName: string
  Title: Checklist Name

  Read Only: true

  Maximum Length: 50

  Name of the checklist.
• checklistTaskAssignments: array Checklist Task Assignments
  Title: Checklist Task Assignments

  The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.
• CompletedTaskCount: integer
  Title: Number of Completed Tasks

  Read Only: true

  Number of completed tasks.
• CompleteFlag: boolean
  Title: Checklist Complete

  Maximum Length: 1

  Default Value: false

  Indicates whether the task is completed.
• CompletionDate: string (date-time)
  Title: Checklist Completion Date

  Read Only: true

  Completion date.
• DaysUntilNextTaskDue: integer (int64)
  Read Only: true

  Number of days until the next task's due date.
• DueDate: string (date-time)
  Title: Checklist Due Date

  Due date.
• EventDate: string (date)
  Read Only: true

  Event date.
• InstitutionId: integer (int64)
  Unique identifier for institution.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  Name of institution.
• InstructionText: string
  Title: Checklist Instruction Text

  Read Only: true

  Instructions for the checklist.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NextTaskDueDate: string (date-time)
  Read Only: true

  Due date of next task.
• NotifyAssignedFlag: boolean
  Maximum Length: 1

  Indicates to the user whether the assignee should receive a communication when the task is assigned.
• NotifyCompletedFlag: boolean
  Maximum Length: 1

  Indicates to the user whether the assignee receives a communication upon completion of the task.
• NotifyDueFlag: boolean
  Maximum Length: 1

  Indicates to the user whether the assignee receives a communication when the task is due.
• ReassignmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Allow reassignment.
• RecipientId: integer (int64)
  Title: Checklist Assignee Party Identifier

  Read Only: true

  Unique identifier for recipient.
• SourceObjectCode: string
  Title: Business Process Source Code

  Maximum Length: 50

  Code for source object.
• SourceObjectDisplay: string
  Read Only: true

  Display label for source object.
• SourceObjectId: integer (int64)
  Title: Business Process Source Identifier

  Unique identifier for source object.
• SourceObjectMeaning: string
  Title: Business Process Source

  Read Only: true

  Maximum Length: 80

  Meaning of source object.
• StartDate: string (date-time)
  Title: Checklist Start Date

  Read Only: true

  Start date.
• TaskDetails: string
  Read Only: true

  Details for task.
• TokenFive: string
  Read Only: true

  Token number 5 placeholder used in communication templates.
• TokenFour: string
  Read Only: true

  Token number 4 placeholder used in communication templates.
• TokenOne: string
  Read Only: true

  Token number 1 placeholder used in communication templates.
• TokenThree: string
  Read Only: true

  Token number 3 placeholder used in communication templates.
• TokenTwo: string
  Read Only: true

  Token number 2 placeholder used in communication templates.
• TotalTaskCount: integer
  Title: Total Number of Tasks

  Read Only: true

  Total number of tasks.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Checklist Category Identifier",
            "type":"integer",
            "description":"Unique identifier for checklist category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReassignmentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Allow reassignment.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AssociatedPersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of party associated with the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TokenOne":{
            "type":"string",
            "description":"Token number 1 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "EventDate":{
            "type":"string",
            "description":"Event date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientId":{
            "title":"Checklist Assignee Party Identifier",
            "type":"integer",
            "description":"Unique identifier for recipient.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TokenFour":{
            "type":"string",
            "description":"Token number 4 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "NotifyAssignedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee should receive a communication when the task is assigned.",
            "nullable":false,
            "x-queryable":true
        },
        "AssigneeEmail":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"Preferred email of party assigned to the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AssociatedPersonName":{
            "title":"Associated Person",
            "maxLength":"450",
            "type":"string",
            "description":"Name of party associated with the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist Setup Identifier",
            "type":"integer",
            "description":"Unique identifier for the checklist.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChecklistAssignmentId":{
            "title":"Checklist Assignment Identifier",
            "type":"integer",
            "description":"Unique identifier for an instance of checklist assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChecklistCode":{
            "title":"Checklist Code",
            "maxLength":"50",
            "type":"string",
            "description":"Code for checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Checklist Start Date",
            "type":"string",
            "description":"Start date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistName":{
            "title":"Checklist Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionText":{
            "title":"Checklist Instruction Text",
            "type":"string",
            "description":"Instructions for the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "InstructionTextClob"
                ]
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Business Process Source Code",
            "maxLength":"50",
            "type":"string",
            "description":"Code for source object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CompletedTaskCount":{
            "title":"Number of Completed Tasks",
            "type":"integer",
            "description":"Number of completed tasks.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskDetails":{
            "type":"string",
            "description":"Details for task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextTaskDueDate":{
            "type":"string",
            "description":"Due date of next task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DaysUntilNextTaskDue":{
            "type":"integer",
            "description":"Number of days until the next task's due date.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255"
            },
            "x-queryable":true
        },
        "AssigneeLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of party assigned to the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "DueDate":{
            "title":"Checklist Due Date",
            "type":"string",
            "description":"Due date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneePartyId":{
            "title":"Checklist Assignee Party Identifier",
            "type":"integer",
            "description":"Party assigned to the checklist.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Checklist Completion Date",
            "type":"string",
            "description":"Completion date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedPartyId":{
            "title":"Checklist Assignment Associated Party Identifier",
            "type":"integer",
            "description":"Party identifier associated with the checklist.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssigneeName":{
            "title":"Assignee",
            "maxLength":"450",
            "type":"string",
            "description":"Name of party assigned to the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "TotalTaskCount":{
            "title":"Total Number of Tasks",
            "type":"integer",
            "description":"Total number of tasks.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectDisplay":{
            "type":"string",
            "description":"Display label for source object.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "NotifyCompletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication upon completion of the task.",
            "nullable":false,
            "x-queryable":true
        },
        "AssigneeFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of party assigned to the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"Name of institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "type":"integer",
            "description":"Unique identifier for institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceObjectMeaning":{
            "title":"Business Process Source",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of source object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TokenFive":{
            "type":"string",
            "description":"Token number 5 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "CompleteFlag":{
            "title":"Checklist Complete",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the task is completed.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Business Process Source Identifier",
            "type":"integer",
            "description":"Unique identifier for source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NotifyDueFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication when the task is due.",
            "nullable":false,
            "x-queryable":true
        },
        "AssociatedPersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of party associated with the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ChecklistAssignmentURL":{
            "type":"string",
            "description":"URL for checklist assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CategoryName":{
            "maxLength":"50",
            "type":"string",
            "description":"Name of checklist category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TokenThree":{
            "type":"string",
            "description":"Token number 3 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "checklistTaskAssignments":{
            "title":"Checklist Task Assignments",
            "type":"array",
            "description":"The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.",
            "items":{
                "$ref":"#/components/schemas/hedChecklistAssignments-checklistTaskAssignments-item-response"
            }
        },
        "TokenTwo":{
            "type":"string",
            "description":"Token number 2 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Checklist Task Assignments

Type: array

Title: Checklist Task Assignments

The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.

Show Source

• Array of: object hedChecklistAssignments-checklistTaskAssignments-item-response

{
    "title":"Checklist Task Assignments",
    "type":"array",
    "description":"The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.",
    "items":{
        "$ref":"#/components/schemas/hedChecklistAssignments-checklistTaskAssignments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedChecklistAssignments-checklistTaskAssignments-item-response

Type: object

Show Source

• CompleteFlag: boolean
  Title: Task Complete

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the task is completed.
• CompletionDate: string (date-time)
  Title: Task Completion Date

  Read Only: true

  Completion date.
• DueDate: string (date-time)
  Title: Task Assignment Due Date

  Due date.
• InstructionText: string
  Title: Task Instruction Text

  Read Only: true

  Instructions for the task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotifyAssignedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee should receive a communication when the task is assigned.
• NotifyCompletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication upon completion of the task.
• NotifyDueFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication when the task is due.
• StarredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.
• StartDate: string (date-time)
  Title: Task Start Date

  Read Only: true

  Start date.
• StatusCode: string
  Title: Task Outcome Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_STATUS_IN_PROGRESS

  Status code.
• StatusMeaning: string
  Title: Task Outcome Status

  Read Only: true

  Maximum Length: 80

  Meaning of status.
• TaskAssignmentId: integer (int64)
  Title: Task Assignment Identifier

  Read Only: true

  Unique identifier for an instance of task assignment within a checklist.
• TaskCode: string
  Title: Task Code

  Read Only: true

  Maximum Length: 50

  Code for task.
• TaskDescription: string
  Title: Task Description

  Read Only: true

  Maximum Length: 240

  Description of task.
• TaskId: integer (int64)
  Title: Task Identifier

  Unique identifier for the task.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 50

  Name of task.

{
    "type":"object",
    "properties":{
        "NotifyCompletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication upon completion of the task.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"Unique identifier for the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NotifyAssignedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee should receive a communication when the task is assigned.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "StarredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Task Outcome Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code.",
            "nullable":false,
            "default":"ORA_HEY_STATUS_IN_PROGRESS",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Task Start Date",
            "type":"string",
            "description":"Start date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompleteFlag":{
            "title":"Task Complete",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the task is completed.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Task Outcome Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":"50",
            "type":"string",
            "description":"Code for task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NotifyDueFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication when the task is due.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TaskDescription":{
            "title":"Task Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionText":{
            "title":"Task Instruction Text",
            "type":"string",
            "description":"Instructions for the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InstructionTextClob"
                ]
            },
            "x-queryable":true
        },
        "TaskAssignmentId":{
            "title":"Task Assignment Identifier",
            "type":"integer",
            "description":"Unique identifier for an instance of task assignment within a checklist.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DueDate":{
            "title":"Task Assignment Due Date",
            "type":"string",
            "description":"Due date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Task Completion Date",
            "type":"string",
            "description":"Completion date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

academicInstitutionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionName; Target Attribute: InstitutionName
• Display Attribute: InstitutionName

checklistTaskAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}/child/checklistTaskAssignments

Parameters:

• hedChecklistAssignmentsUniqID: $request.path.hedChecklistAssignmentsUniqID

The HED checklist task assignments resource is a child of the HED checklist assignments resource and provides a complete list of tasks assigned to a checklist of assignments.

sourceObjectCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_TASK_OBJECT_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: SourceObjectCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top