Jump to

• Request
• Response

Create a task assignment

post

/fscmRestApi/resources/11.13.18.05/hedTaskAssignments

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: Task Assignee Party Identifier

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

  Party identifier associated with the task.
• AttachmentDescription: string
  Title: Attachment Description

  Description of attachment.
• AttachmentFileContents: string (byte)
  Title: Attachment File Contents

  Attachment file.
• AttachmentFileName: string
  Title: Attachment File Name

  Name of attachment file.
• AttachmentId: integer (int64)
  Title: Attachment Identifier

  Unique identifier for attachment.
• AttachmentMetadata: string
  Title: Attachment Metadata

  Maximum Length: 4000

  Attachment metadata.
• AttachmentTitle: string
  Title: Attachment Title

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

  Due date.
• InstitutionId: integer (int64)
  Title: Task Institution Identifier

  Unique identifier for institution.
• InstitutionName: string
  Title: Task Institution Name

  Maximum Length: 50

  Name of institution.
• NotifyAssignedFlag: boolean
  Title: Notify Assigned Indicator

  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee should receive a communication when the task is assigned.
• NotifyCompletedFlag: boolean
  Title: Notify Completed Indicator

  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication upon completion of the task.
• NotifyDueFlag: boolean
  Title: Notify Due Indicator

  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication when the task is due.
• PurposeTypeCode: string
  Title: Purpose Type Code

  Maximum Length: 50

  Code for assignment purpose.
• ReassignmentFlag: boolean
  Title: Allow Reassignment

  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.
• StarredFlag: boolean
  Title: Starred Indicator

  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.
• StatusSchemeId: integer (int64)
  Title: Status Scheme Identifier

  Unique identifier for status scheme.
• TaskId: integer (int64)
  Title: Task Identifier

  Unique identifier for the task.

{
    "type":"object",
    "properties":{
        "ReassignmentFlag":{
            "title":"Allow Reassignment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Allow reassignment.",
            "nullable":false,
            "default":false
        },
        "AttachmentTitle":{
            "title":"Attachment Title",
            "type":"string",
            "description":"Title of attachment.",
            "nullable":true
        },
        "NotifyCompletedFlag":{
            "title":"Notify Completed Indicator",
            "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"
            }
        },
        "InstitutionName":{
            "title":"Task Institution Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstitutionId":{
            "title":"Task Institution Identifier",
            "type":"integer",
            "description":"Unique identifier for institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyAssignedFlag":{
            "title":"Notify Assigned Indicator",
            "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
        },
        "AttachmentMetadata":{
            "title":"Attachment Metadata",
            "maxLength":"4000",
            "type":"string",
            "description":"Attachment metadata.",
            "nullable":true
        },
        "AttachmentFileName":{
            "title":"Attachment File Name",
            "type":"string",
            "description":"Name of attachment file.",
            "nullable":true
        },
        "AttachmentDescription":{
            "title":"Attachment Description",
            "type":"string",
            "description":"Description of attachment.",
            "nullable":true
        },
        "StarredFlag":{
            "title":"Starred Indicator",
            "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
        },
        "AttachmentFileContents":{
            "title":"Attachment File Contents",
            "type":"string",
            "description":"Attachment file.",
            "format":"byte",
            "nullable":true
        },
        "PurposeTypeCode":{
            "title":"Purpose Type Code",
            "maxLength":"50",
            "type":"string",
            "description":"Code for assignment purpose.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "AttachmentId":{
            "title":"Attachment Identifier",
            "type":"integer",
            "description":"Unique identifier for attachment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceObjectId":{
            "title":"Business Process Source Identifier",
            "type":"integer",
            "description":"Unique identifier for source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyDueFlag":{
            "title":"Notify Due Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication when the task is due.",
            "nullable":false,
            "default":false
        },
        "SourceObjectCode":{
            "title":"Business Process Source Code",
            "maxLength":"50",
            "type":"string",
            "description":"Code for source object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusSchemeId":{
            "title":"Status Scheme Identifier",
            "type":"integer",
            "description":"Unique identifier for status scheme.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DueDate":{
            "title":"Task Assignment Due Date",
            "type":"string",
            "description":"Due date.",
            "format":"date-time",
            "nullable":true
        },
        "AssigneePartyId":{
            "title":"Task Assignee Party Identifier",
            "type":"integer",
            "description":"Party assigned to the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssociatedPartyId":{
            "title":"Task Assignment Associated Party Identifier",
            "type":"integer",
            "description":"Party identifier associated with the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : hedTaskAssignments-item-response

Type: object

Show Source

• AssigneeEmail: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 450

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

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

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 450

  Name of party associated with the task.
• AttachmentDescription: string
  Title: Attachment Description

  Description of attachment.
• AttachmentFileContents: string (byte)
  Title: Attachment File Contents

  Attachment file.
• AttachmentFileName: string
  Title: Attachment File Name

  Name of attachment file.
• AttachmentFileURL: string
  Title: Attachment File URL

  Read Only: true

  URL for attachment file.
• AttachmentId: integer (int64)
  Title: Attachment Identifier

  Unique identifier for attachment.
• AttachmentMetadata: string
  Title: Attachment Metadata

  Maximum Length: 4000

  Attachment metadata.
• AttachmentTitle: string
  Title: Attachment Title

  Title of attachment.
• AttachmentUploadedFileContentType: string
  Title: Attachment Uploaded File Content Type

  Read Only: true

  Content type for attachment file.
• CategoryId: integer (int64)
  Title: Task Category Identifier

  Read Only: true

  Unique identifier for task category.
• CategoryName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Unique identifier for an instance of checklist assignment.
• ChecklistId: integer (int64)
  Title: Checklist Setup Identifier

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

  Name of checklist.
• 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.
• DaysUntilDue: integer
  Title: Days Until Due

  Read Only: true

  Number of days until the due date.
• DocumentTypeCode: string
  Title: Document Type Code

  Read Only: true

  Maximum Length: 30

  Code for document type.
• DocumentTypeMeaning: string
  Title: Document Type Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of document type.
• DueDate: string (date-time)
  Title: Task Assignment Due Date

  Due date.
• EventDate: string (date)
  Title: Event Date

  Read Only: true

  Event date.
• InstitutionId: integer (int64)
  Title: Task Institution Identifier

  Unique identifier for institution.
• InstitutionName: string
  Title: Task Institution Name

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 255

  Instructions for the task.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Last updated date.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Last updated by.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotifyAssignedFlag: boolean
  Title: Notify Assigned Indicator

  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee should receive a communication when the task is assigned.
• NotifyCompletedFlag: boolean
  Title: Notify Completed Indicator

  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication upon completion of the task.
• NotifyDueFlag: boolean
  Title: Notify Due Indicator

  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication when the task is due.
• PurposeTypeCode: string
  Title: Purpose Type Code

  Maximum Length: 50

  Code for assignment purpose.
• PurposeTypeMeaning: string
  Title: Purpose Type

  Read Only: true

  Maximum Length: 80

  Meaning of assignment purpose.
• ReassignmentFlag: boolean
  Title: Allow Reassignment

  Maximum Length: 1

  Default Value: false

  Allow reassignment.
• RecipientId: integer
  Title: Recipient Identifier

  Read Only: true

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

  Maximum Length: 50

  Code for source object.
• SourceObjectDisplay: string
  Title: Source Object Display

  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.
• StarredFlag: boolean
  Title: Starred Indicator

  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.
• StatusSchemeCode: string
  Title: Status Scheme Code

  Read Only: true

  Maximum Length: 30

  Code for status scheme.
• StatusSchemeId: integer (int64)
  Title: Status Scheme Identifier

  Unique identifier for status scheme.
• StatusSchemeName: string
  Title: Status Scheme Name

  Read Only: true

  Maximum Length: 60

  Name of status scheme.
• StatusTypeCode: string
  Title: Status Type Code

  Read Only: true

  Maximum Length: 30

  Code for status type.
• StatusTypeMeaning: string
  Title: Status Type Meaning

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Unique identifier for an instance of task assignment.
• TaskAssignmentURL: string
  Title: Task Assignment URL

  Read Only: true

  URL for task assignment.
• TaskDescription: string
  Title: Task Description

  Read Only: true

  Maximum Length: 240

  Description of the 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 the task.
• TaskTypeCode: string
  Title: Task Type Code

  Read Only: true

  Maximum Length: 30

  Code for task type.
• TaskTypeMeaning: string
  Title: Task Type Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of task type.
• TokenFive: string
  Title: Token Five

  Read Only: true

  Token number 5 placeholder used in communication templates.
• TokenFour: string
  Title: Token Four

  Read Only: true

  Token number 4 placeholder used in communication templates.
• TokenOne: string
  Title: Token One

  Read Only: true

  Default Value: adf.object.getCommunicationToken(1)

  Token number 1 placeholder used in communication templates.
• TokenThree: string
  Title: Token Three

  Read Only: true

  Token number 3 placeholder used in communication templates.
• TokenTwo: string
  Title: Token Two

  Read Only: true

  Token number 2 placeholder used in communication templates.

{
    "type":"object",
    "properties":{
        "AttachmentTitle":{
            "title":"Attachment Title",
            "type":"string",
            "description":"Title of attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskTypeCode":{
            "title":"Task Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for task type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedPersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of party associated with the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "AttachmentFileURL":{
            "title":"Attachment File URL",
            "type":"string",
            "description":"URL for attachment file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDate":{
            "title":"Event Date",
            "type":"string",
            "description":"Event date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotifyAssignedFlag":{
            "title":"Notify Assigned Indicator",
            "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
        },
        "AssigneeEmail":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"Preferred email of party assigned to the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist Setup Identifier",
            "type":"integer",
            "description":"Unique identifier for checklist setup.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociatedPersonName":{
            "title":"Associated Person",
            "maxLength":"450",
            "type":"string",
            "description":"Name of party associated with the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "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
        },
        "InstructionText":{
            "title":"Task Instruction Text",
            "maxLength":"255",
            "type":"string",
            "description":"Instructions for the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "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
        },
        "TaskAssignmentId":{
            "title":"Task Assignment Identifier",
            "type":"integer",
            "description":"Unique identifier for an instance of task assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme Identifier",
            "type":"integer",
            "description":"Unique identifier for status scheme.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaskAssignmentURL":{
            "title":"Task Assignment URL",
            "type":"string",
            "description":"URL for task assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Last updated by.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentUploadedFileContentType":{
            "title":"Attachment Uploaded File Content Type",
            "type":"string",
            "description":"Content type for attachment file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysUntilDue":{
            "title":"Days Until Due",
            "type":"integer",
            "description":"Number of days until the due date.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DueDate"
                ]
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Task Institution Identifier",
            "type":"integer",
            "description":"Unique identifier for institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentMetadata":{
            "title":"Attachment Metadata",
            "maxLength":"4000",
            "type":"string",
            "description":"Attachment metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentFileName":{
            "title":"Attachment File Name",
            "type":"string",
            "description":"Name of attachment file.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskTypeMeaning":{
            "title":"Task Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of task type.",
            "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
        },
        "NotifyDueFlag":{
            "title":"Notify Due Indicator",
            "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
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeCode":{
            "title":"Status Scheme Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for status scheme.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssociatedPersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of party associated with the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "TokenTwo":{
            "title":"Token Two",
            "type":"string",
            "description":"Token number 2 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Task Category Identifier",
            "type":"integer",
            "description":"Unique identifier for task category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReassignmentFlag":{
            "title":"Allow Reassignment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Allow reassignment.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TokenOne":{
            "title":"Token One",
            "type":"string",
            "description":"Token number 1 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "default":"adf.object.getCommunicationToken(1)",
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "RecipientId":{
            "title":"Recipient Identifier",
            "type":"integer",
            "description":"Unique identifier for recipient.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AssigneePartyId"
                ]
            },
            "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
        },
        "TokenFour":{
            "title":"Token Four",
            "type":"string",
            "description":"Token number 4 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "AttachmentDescription":{
            "title":"Attachment Description",
            "type":"string",
            "description":"Description of attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "StarredFlag":{
            "title":"Starred Indicator",
            "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
        },
        "AttachmentFileContents":{
            "title":"Attachment File Contents",
            "type":"string",
            "description":"Attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "PurposeTypeCode":{
            "title":"Purpose Type Code",
            "maxLength":"50",
            "type":"string",
            "description":"Code for assignment purpose.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChecklistAssignmentId":{
            "title":"Checklist Assignment Identifier",
            "type":"integer",
            "description":"Unique identifier for an instance of checklist assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChecklistName":{
            "title":"Checklist Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskDescription":{
            "title":"Task Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeName":{
            "title":"Status Scheme Name",
            "maxLength":"60",
            "type":"string",
            "description":"Name of status scheme.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for document type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusTypeMeaning":{
            "title":"Status Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of status type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of party assigned to the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "DueDate":{
            "title":"Task Assignment Due Date",
            "type":"string",
            "description":"Due date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneePartyId":{
            "title":"Task Assignee Party Identifier",
            "type":"integer",
            "description":"Party assigned to the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Task Completion Date",
            "type":"string",
            "description":"Completion date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedPartyId":{
            "title":"Task Assignment Associated Party Identifier",
            "type":"integer",
            "description":"Party identifier associated with the task.",
            "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 task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "SourceObjectDisplay":{
            "title":"Source Object Display",
            "type":"string",
            "description":"Display label for source object.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "NotifyCompletedFlag":{
            "title":"Notify Completed Indicator",
            "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
        },
        "AssigneeFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of party assigned to the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Task Institution Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentTypeMeaning":{
            "title":"Document Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectMeaning":{
            "title":"Business Process Source",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of source object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentId":{
            "title":"Attachment Identifier",
            "type":"integer",
            "description":"Unique identifier for attachment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PurposeTypeMeaning":{
            "title":"Purpose Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of assignment purpose.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusTypeCode":{
            "title":"Status Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for status type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Task Outcome Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TokenFive":{
            "title":"Token Five",
            "type":"string",
            "description":"Token number 5 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "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
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of task category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TokenThree":{
            "title":"Token Three",
            "type":"string",
            "description":"Token number 3 placeholder used in communication templates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last updated date.",
            "format":"date-time",
            "nullable":false,
            "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

purposeTypeCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TASK_PURPOSE_CODE%2CLookupCode%3D{PurposeTypeCode}

The following properties are defined on the LOV link relation:

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

sourceObjectCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TASK_OBJECT_CODE%2CLookupCode%3D{SourceObjectCode}

The following properties are defined on the LOV link relation:

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

statusSchemesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemesLOV

Parameters:

• finder: ByCategoryAndInstitutionFinder%3BCategoryName%3D{CategoryName}%2CInstitutionName%3D{InstitutionName}

The following properties are defined on the LOV link relation:

• Source Attribute: StatusSchemeCode; Target Attribute: StatusSchemeCode
• Display Attribute: StatusSchemeName

statusSchemesStatusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemesStatusesLOV

Parameters:

• finder: ByStatusSchemeCodeFinder%3BStatusSchemeCode%3D{StatusSchemeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: StatusCode
• Display Attribute: StatusMeaning

Back to Top