Jump to

• Request
• Response

Update a task assignment

patch

/fscmRestApi/resources/11.13.18.05/hedTaskAssignments/{hedTaskAssignmentsUniqID}

Request

Path Parameters

• hedTaskAssignmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Task Assignments resource and used to uniquely identify an instance of Task Assignments. The client should not generate the hash key value. Instead, the client should query on the Task Assignments collection resource in order to navigate to a specific instance of Task Assignments to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  The unique identifier of the person the higher education task is assigned to.
• AttachmentDescription: string
  Indicates the description of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentDescription.
• AttachmentFileContents: string (byte)
  The file contents of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileContents.
• AttachmentFileName: string
  Indicates the file name of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileName. To delete an attachment, the consumer needs to send null to AttachmentFileName.
• AttachmentId: integer (int64)
  The unique attachment identifier for the higher education task.
• AttachmentMetadata: string
  Maximum Length: 4000

  The attachment metadata that contains details of the attachment.
• AttachmentTitle: string
  Indicates the title of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentTitle.
• ReassignmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the task allows reassignment.
• 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

  The status code associated with the state of the task, for example ORA_HEY_ACTION_INPROGRESS, ORA_HEY_ACTION_COMPLETE.

{
    "type":"object",
    "properties":{
        "AttachmentTitle":{
            "type":"string",
            "description":"Indicates the title of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentTitle.",
            "nullable":true
        },
        "ReassignmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task allows reassignment.",
            "nullable":false,
            "default":false
        },
        "AttachmentMetadata":{
            "maxLength":4000,
            "type":"string",
            "description":"The attachment metadata that contains details of the attachment.",
            "nullable":true
        },
        "AttachmentFileName":{
            "type":"string",
            "description":"Indicates the file name of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileName. To delete an attachment, the consumer needs to send null to AttachmentFileName.",
            "nullable":true
        },
        "AttachmentDescription":{
            "type":"string",
            "description":"Indicates the description of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentDescription.",
            "nullable":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
        },
        "AttachmentFileContents":{
            "type":"string",
            "description":"The file contents of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileContents.",
            "format":"byte",
            "nullable":true
        },
        "AssigneePartyId":{
            "title":"Task Assignee Party Identifier",
            "type":"integer",
            "description":"The unique identifier of the person the higher education task is assigned to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCode":{
            "title":"Task Outcome Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code associated with the state of the task, for example ORA_HEY_ACTION_INPROGRESS, ORA_HEY_ACTION_COMPLETE.",
            "nullable":false,
            "default":"ORA_HEY_STATUS_IN_PROGRESS",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique attachment identifier for the higher education 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(required):
  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(required):
  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

  Indicates the first name of the person to whom a task or a checklist is assigned.
• AssigneeLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Indicates the last name of the person to whom a task or a checklist is assigned.
• AssigneeName: string
  Title: Assignee

  Read Only: true

  Maximum Length: 450

  Indicates the person to whom a task or a checklist is assigned.
• AssigneePartyId: integer (int64)
  Title: Task Assignee Party Identifier

  The unique identifier of the person the higher education task is assigned to.
• AssociatedPartyId: integer (int64)
  Title: Task Assignment Associated Party Identifier

  The identifier for the individual associated with the higher education task.
• AssociatedPersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  Indicates the first name of the person to whom a task or a checklist is related.
• AssociatedPersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Indicates the last name of the person to whom a task or a checklist is related.
• AssociatedPersonName: string
  Title: Associated Person

  Read Only: true

  Maximum Length: 450

  Indicates the person to whom a task or a checklist is related.
• AttachmentDescription: string
  Indicates the description of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentDescription.
• AttachmentFileContents: string (byte)
  The file contents of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileContents.
• AttachmentFileName: string
  Indicates the file name of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileName. To delete an attachment, the consumer needs to send null to AttachmentFileName.
• AttachmentFileURL: string
  Read Only: true

  Indicates the URL of the file.
• AttachmentId: integer (int64)
  The unique attachment identifier for the higher education task.
• AttachmentMetadata: string
  Maximum Length: 4000

  The attachment metadata that contains details of the attachment.
• AttachmentTitle: string
  Indicates the title of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentTitle.
• AttachmentUploadedFileContentType: string
  Read Only: true

  Indicates the content type of the uploaded file.
• CategoryId: integer (int64)
  Title: Task Category Identifier

  Read Only: true

  The unique identifier for the category where the higher education task is created.
• CategoryName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 50

  The name of the category where the higher education task is created.
• ChecklistAssignmentId: integer (int64)
  Title: Checklist Assignment Identifier

  Read Only: true

  The unique checklist instance identifier for the higher education checklist.
• ChecklistId: integer (int64)
  Title: Checklist Setup Identifier

  Read Only: true

  The unique identifier for the higher education checklist.
• ChecklistName: string
  Title: Checklist Name

  Read Only: true

  Maximum Length: 50

  The name that an administrator provides for the higher education checklist.
• CompleteFlag: boolean
  Title: Task Complete

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  The date on which the task is completed.
• DaysUntilDue: integer
  Read Only: true

  Number of days until the due date.
• DocumentTypeCode: string
  Read Only: true

  Maximum Length: 30

  The code for the document type, such as ORA_HEY_ESSAY.
• DocumentTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the document type, such as "Essay".
• DueDate: string (date-time)
  Title: Task Assignment Due Date

  The date on which the assigned task is due.
• EventDate: string (date)
  Read Only: true

  The event date of the higher education task.
• InstitutionId: integer (int64)
  The unique identifier for the institution where the higher education task is created.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The name of the institution where the higher education task is created.
• InstructionText: string
  Title: Task Instruction Text

  Read Only: true

  Maximum Length: 255

  The instruction that an administrator provides for the higher education 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
  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.
• ReassignmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the task allows reassignment.
• RecipientId: integer
  Read Only: true

  The unique recipient identifier for the higher education task.
• SourceObjectCode: string
  Title: Business Process Source Code

  Maximum Length: 50

  The unique code for the source object for which this checklist is assigned, for example a code of the admission application form.
• SourceObjectDisplay: string
  Read Only: true

  Indicates the business process source display from which the checklist was assigned.
• SourceObjectId: integer (int64)
  Title: Business Process Source Identifier

  The unique identifier for the source object for which this checklist is assigned, for example an identifier of the admission application form.
• SourceObjectMeaning: string
  Title: Business Process Source

  Read Only: true

  Maximum Length: 80

  Indicates the business process source from which the checklist was assigned.
• 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

  The date on which the task is started.
• StatusCode: string
  Title: Task Outcome Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_STATUS_IN_PROGRESS

  The status code associated with the state of the task, for example ORA_HEY_ACTION_INPROGRESS, ORA_HEY_ACTION_COMPLETE.
• StatusMeaning: string
  Title: Task Outcome Status

  Read Only: true

  Maximum Length: 80

  The status associated with the state of the task, for example in progress, complete, error, or waived state.
• StatusSchemeCode: string
  Read Only: true

  Maximum Length: 30

  The status scheme code, such as a code for a group of statuses for admissions.
• StatusSchemeId: integer (int64)
  The unique identifier for a status scheme associated with the task.
• StatusSchemeName: string
  Read Only: true

  Maximum Length: 60

  The name of the status scheme, such as admissions statuses.
• StatusTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code for status type.
• StatusTypeMeaning: string
  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  The unique task instance identifier for the higher education task.
• TaskAssignmentURL: string
  Read Only: true

  The URL that can be used to directly access the task assignment drill down page.
• TaskDescription: string
  Title: Task Description

  Read Only: true

  Maximum Length: 240

  The description that an administrator provides for the higher education task.
• TaskId: integer (int64)
  Title: Task Identifier

  The unique identifier for the higher education task.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 50

  The name that an administrator provides for the higher education task.
• TaskTypeCode: string
  Read Only: true

  Maximum Length: 30

  The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.
• TaskTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the type of task, such as a document submission 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

  Default Value: adf.object.getCommunicationToken(1)

  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.

{
    "type":"object",
    "properties":{
        "AttachmentTitle":{
            "type":"string",
            "description":"Indicates the title of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentTitle.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedPersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Indicates the last name of the person to whom a task or a checklist is related.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "AttachmentFileURL":{
            "type":"string",
            "description":"Indicates the URL of the file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDate":{
            "type":"string",
            "description":"The event date of the higher education task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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":"The unique identifier for the higher education checklist.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssociatedPersonName":{
            "title":"Associated Person",
            "maxLength":450,
            "type":"string",
            "description":"Indicates the person to whom a task or a checklist is related.",
            "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":"The status code associated with the state of the task, for example ORA_HEY_ACTION_INPROGRESS, ORA_HEY_ACTION_COMPLETE.",
            "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":"The date on which the task is started.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionText":{
            "title":"Task Instruction Text",
            "maxLength":255,
            "type":"string",
            "description":"The instruction that an administrator provides for the higher education task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InstructionTextClob"
                ]
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Business Process Source Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code for the source object for which this checklist is assigned, for example a code of the admission application form.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaskAssignmentId":{
            "title":"Task Assignment Identifier",
            "type":"integer",
            "description":"The unique task instance identifier for the higher education task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusSchemeId":{
            "type":"integer",
            "description":"The unique identifier for a status scheme associated with the task.",
            "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":{
            "type":"string",
            "description":"The URL that can be used to directly access the task assignment drill down page.",
            "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":{
            "type":"string",
            "description":"Indicates the content type of the uploaded file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysUntilDue":{
            "type":"integer",
            "description":"Number of days until the due date.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DueDate"
                ]
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "type":"integer",
            "description":"The unique identifier for the institution where the higher education task is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttachmentMetadata":{
            "maxLength":4000,
            "type":"string",
            "description":"The attachment metadata that contains details of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentFileName":{
            "type":"string",
            "description":"Indicates the file name of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileName. To delete an attachment, the consumer needs to send null to AttachmentFileName.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of task, such as a document submission task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompleteFlag":{
            "title":"Task Complete",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task is completed or not.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "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
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":50,
            "type":"string",
            "description":"The name that an administrator provides for the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status scheme code, such as a code for a group of statuses for admissions.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssociatedPersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"Indicates the first name of the person to whom a task or a checklist is related.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "TokenTwo":{
            "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":"The unique identifier for the category where the higher education task is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReassignmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task allows reassignment.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TokenOne":{
            "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":{
            "type":"integer",
            "description":"The unique recipient identifier for the higher education task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AssigneePartyId"
                ]
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"The unique identifier for the higher education task.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "AttachmentDescription":{
            "type":"string",
            "description":"Indicates the description of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentDescription.",
            "nullable":true,
            "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
        },
        "AttachmentFileContents":{
            "type":"string",
            "description":"The file contents of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileContents.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ChecklistAssignmentId":{
            "title":"Checklist Assignment Identifier",
            "type":"integer",
            "description":"The unique checklist instance identifier for the higher education checklist.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChecklistName":{
            "title":"Checklist Name",
            "maxLength":50,
            "type":"string",
            "description":"The name that an administrator provides for the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskDescription":{
            "title":"Task Description",
            "maxLength":240,
            "type":"string",
            "description":"The description that an administrator provides for the higher education task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for the document type, such as ORA_HEY_ESSAY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusTypeMeaning":{
            "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":"Indicates the last name of the person to whom a task or a checklist is assigned.",
            "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":"The date on which the assigned task is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneePartyId":{
            "title":"Task Assignee Party Identifier",
            "type":"integer",
            "description":"The unique identifier of the person the higher education task is assigned to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Task Completion Date",
            "type":"string",
            "description":"The date on which the task is completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedPartyId":{
            "title":"Task Assignment Associated Party Identifier",
            "type":"integer",
            "description":"The identifier for the individual associated with the higher education task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssigneeName":{
            "title":"Assignee",
            "maxLength":450,
            "type":"string",
            "description":"Indicates the person to whom a task or a checklist is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "SourceObjectDisplay":{
            "type":"string",
            "description":"Indicates the business process source display from which the checklist was assigned.",
            "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,
            "default":false,
            "x-queryable":true
        },
        "AssigneeFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"Indicates the first name of the person to whom a task or a checklist is assigned.",
            "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":"The name of the institution where the higher education task is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the document type, such as \"Essay\".",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectMeaning":{
            "title":"Business Process Source",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the business process source from which the checklist was assigned.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique attachment identifier for the higher education task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusTypeCode":{
            "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":"The status associated with the state of the task, for example in progress, complete, error, or waived state.",
            "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
        },
        "SourceObjectId":{
            "title":"Business Process Source Identifier",
            "type":"integer",
            "description":"The unique identifier for the source object for which this checklist is assigned, for example an identifier of the admission application form.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the category where the higher education task is created.",
            "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
        },
        "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 list of values for the academic institution of the higher education task assignments.

The following properties are defined on the LOV link relation:

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

sourceObjectCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_TASK_OBJECT_CODE

The list of values for the source object of the higher education task assignments.

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