Jump to

• Request
• Response

Update a higher education task setup

patch

/fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}

Request

Path Parameters

• TaskId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• 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

• CategoryId: integer (int64)
  Title: Task Category Identifier

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

  Maximum Length: 50

  The name of the category where the higher education task is created.
• Comments: string
  Title: Comments

  Default Value: CommentsClob

  Author's comment on the task definition.
• DocumentTypeCode: string
  Title: Document Type Code

  Maximum Length: 30

  The code for the type of document, such as a ORA_HEY_ESSAY.
• DueDate: string (date-time)
  Title: Task Due Date

  The due date of the higher education task.
• InstitutionId: integer (int64)
  Title: Task Institution Identifier

  The unique identifier for the institution where the higher education task is created.
• InstitutionName: string
  Title: Task Institution Name

  Maximum Length: 50

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

  The instruction that an administrator provides for the higher education task.
• PivotDateCount: integer (int32)
  Title: Task Pivot Date Count

  The pivot date count for the higher education task. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12.
• PivotDatePredicateCode: string
  Title: Task Pivot Date Predicate Code

  Maximum Length: 30

  The code for the pivot date predicate of the higher education task. For example, the PivotDatePredicateCode from the following condition, 12 weeks after assigned date, is ORA_HEY_AFTER.
• PivotDateTimeIntervalCode: string
  Title: Task Pivot Date Time Interval Code

  Maximum Length: 30

  The code for the pivot date time interval of the higher education task. For example, the PivotDateTimeIntervalCode from the following condition, 12 weeks after assigned date, is ORA_HEY_WEEKS.
• PivotDateTypeCode: string
  Title: Task Pivot Date Type Code

  Maximum Length: 30

  The code for the pivot date type of the higher education task. For example, the PivotDateTypeCode from the following condition, 12 weeks after assigned date, is ORA_HEY_ASSIGNED_DATE.
• PreferredTimeZoneCode: string
  Title: Preferred Time Zone Code

  Maximum Length: 50

  The list of values for the preferred time zone.
• StatusSchemeCode(required): string
  Title: Status Scheme Code

  Maximum Length: 30

  The status scheme code, such as a code for a group of statuses for admissions.
• StatusSchemeId(required): integer (int64)
  Title: Status Scheme Identifier

  The unique identifier for a status scheme associated with the task.
• tagAssignments: array Task Tags
  Title: Task Tags

  The task tags provide a user with a complete list of tags assigned to a task.
• TaskCode(required): string
  Title: Task Code

  Maximum Length: 50

  The code for the higher education task.
• TaskDescription: string
  Title: Task Description

  Maximum Length: 240

  The description that an administrator provides for the higher education task.
• TaskName(required): string
  Title: Task Name

  Maximum Length: 50

  The name that an administrator provides for the higher education task.
• TaskStatusCode: string
  Title: Task Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_DRAFT

  The status code of the higher education task.
• TaskTypeCode: string
  Title: Task Type Code

  Maximum Length: 30

  Default Value: ORA_HEY_MANUAL_TASK

  The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.

{
    "required":[
        "StatusSchemeCode",
        "StatusSchemeId",
        "TaskCode",
        "TaskName"
    ],
    "type":"object",
    "properties":{
        "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,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "CategoryName"
                ]
            }
        },
        "PivotDateTypeCode":{
            "title":"Task Pivot Date Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the pivot date type of the higher education task. For example, the PivotDateTypeCode from the following condition, 12 weeks after assigned date, is ORA_HEY_ASSIGNED_DATE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "TaskTypeCode":{
            "title":"Task Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.",
            "nullable":false,
            "default":"ORA_HEY_MANUAL_TASK",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "tagAssignments":{
            "title":"Task Tags",
            "type":"array",
            "description":"The task tags provide a user with a complete list of tags assigned to a task.",
            "items":{
                "$ref":"#/components/schemas/hedTaskSetups-tagAssignments-item-patch-request"
            }
        },
        "InstitutionName":{
            "title":"Task Institution Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the institution where the higher education task is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstitutionId":{
            "title":"Task Institution Identifier",
            "type":"integer",
            "description":"The unique identifier for the institution where the higher education task is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "InstitutionName"
                ]
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Author's comment on the task definition.",
            "nullable":true,
            "default":"CommentsClob",
            "x-hints":{
                "dependencies":[
                    "CommentsClob"
                ]
            }
        },
        "TaskStatusCode":{
            "title":"Task Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the higher education task.",
            "nullable":true,
            "default":"ORA_HEY_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PivotDateCount":{
            "title":"Task Pivot Date Count",
            "type":"integer",
            "description":"The pivot date count for the higher education task. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5",
                "PAYLOADHINT":"Show"
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":"50",
            "type":"string",
            "description":"The code for the higher education task.",
            "nullable":false
        },
        "PivotDatePredicateCode":{
            "title":"Task Pivot Date Predicate Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the pivot date predicate of the higher education task. For example, the PivotDatePredicateCode from the following condition, 12 weeks after assigned date, is ORA_HEY_AFTER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "TaskDescription":{
            "title":"Task Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description that an administrator provides for the higher education task.",
            "nullable":true
        },
        "PivotDateTimeIntervalCode":{
            "title":"Task Pivot Date Time Interval Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the pivot date time interval of the higher education task. For example, the PivotDateTimeIntervalCode from the following condition, 12 weeks after assigned date, is ORA_HEY_WEEKS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "PreferredTimeZoneCode":{
            "title":"Preferred Time Zone Code",
            "maxLength":"50",
            "type":"string",
            "description":"The list of values for the preferred time zone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name that an administrator provides for the higher education task.",
            "nullable":false
        },
        "InstructionText":{
            "title":"Instruction Text",
            "type":"string",
            "description":"The instruction that an administrator provides for the higher education task.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InstructionTextClob"
                ]
            }
        },
        "StatusSchemeCode":{
            "title":"Status Scheme Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status scheme code, such as a code for a group of statuses for admissions.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the type of document, such as a ORA_HEY_ESSAY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the category where the higher education task is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusSchemeId":{
            "title":"Status Scheme Identifier",
            "type":"integer",
            "description":"The unique identifier for a status scheme associated with the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StatusSchemeCode"
                ]
            }
        },
        "DueDate":{
            "title":"Task Due Date",
            "type":"string",
            "description":"The due date of the higher education task.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Task Tags

Type: array

Title: Task Tags

The task tags provide a user with a complete list of tags assigned to a task.

Show Source

• Array of: object schema

{
    "title":"Task Tags",
    "type":"array",
    "description":"The task tags provide a user with a complete list of tags assigned to a task.",
    "items":{
        "$ref":"#/components/schemas/hedTaskSetups-tagAssignments-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• AssignedCount: integer
  Title: Number of Assignments

  Read Only: true

  The number of assignments that have been made for the higher education task.
• CategoryId: integer (int64)
  Title: Task Category Identifier

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

  Maximum Length: 50

  The name of the category where the higher education task is created.
• Comments: string
  Title: Comments

  Default Value: CommentsClob

  Author's comment on the task definition.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row for the higher education task.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the higher education task row was created.
• DocumentTypeCode: string
  Title: Document Type Code

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

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

  The due date of the higher education task.
• InstitutionId: integer (int64)
  Title: Task Institution Identifier

  The unique identifier for the institution where the higher education task is created.
• InstitutionName: string
  Title: Task Institution Name

  Maximum Length: 50

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

  The instruction that an administrator provides for the higher education task.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the higher education task row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row for the higher education task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PivotDateCount: integer (int32)
  Title: Task Pivot Date Count

  The pivot date count for the higher education task. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12.
• PivotDatePredicateCode: string
  Title: Task Pivot Date Predicate Code

  Maximum Length: 30

  The code for the pivot date predicate of the higher education task. For example, the PivotDatePredicateCode from the following condition, 12 weeks after assigned date, is ORA_HEY_AFTER.
• PivotDatePredicateMeaning: string
  Title: Task Pivot Date Predicate Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the pivot date predicate of the higher education task.
• PivotDateTimeIntervalCode: string
  Title: Task Pivot Date Time Interval Code

  Maximum Length: 30

  The code for the pivot date time interval of the higher education task. For example, the PivotDateTimeIntervalCode from the following condition, 12 weeks after assigned date, is ORA_HEY_WEEKS.
• PivotDateTimeIntervalMeaning: string
  Title: Task Pivot Date Time Interval Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the pivot date time interval of the higher education task.
• PivotDateTypeCode: string
  Title: Task Pivot Date Type Code

  Maximum Length: 30

  The code for the pivot date type of the higher education task. For example, the PivotDateTypeCode from the following condition, 12 weeks after assigned date, is ORA_HEY_ASSIGNED_DATE.
• PivotDateTypeMeaning: string
  Title: Task Pivot Date Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the pivot date type of the higher education task.
• PreferredTimeZone: string
  Title: Preferred Time Zone

  Read Only: true

  Maximum Length: 80

  The name of the preferred time zone.
• PreferredTimeZoneCode: string
  Title: Preferred Time Zone Code

  Maximum Length: 50

  The list of values for the preferred time zone.
• StatusSchemeCode: string
  Title: Status Scheme Code

  Maximum Length: 30

  The status scheme code, such as a code for a group of statuses for admissions.
• StatusSchemeId: integer (int64)
  Title: Status Scheme Identifier

  The unique identifier for a status scheme associated with the task.
• StatusSchemeName: string
  Title: Status Scheme Name

  Read Only: true

  Maximum Length: 60

  The name of the status scheme, such as admissions statuses.
• tagAssignments: array Task Tags
  Title: Task Tags

  The task tags provide a user with a complete list of tags assigned to a task.
• TaskCode: string
  Title: Task Code

  Maximum Length: 50

  The code for the higher education task.
• TaskDescription: string
  Title: Task Description

  Maximum Length: 240

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

  Read Only: true

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

  Maximum Length: 50

  The name that an administrator provides for the higher education task.
• TaskStatusCode: string
  Title: Task Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_DRAFT

  The status code of the higher education task.
• TaskStatusMeaning: string
  Title: Task Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the status of the higher education task.
• TaskTypeCode: string
  Title: Task Type Code

  Maximum Length: 30

  Default Value: ORA_HEY_MANUAL_TASK

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

  Read Only: true

  Maximum Length: 80

  The meaning of the type of task, such as a document submission task.
• VersionNumber: integer (int32)
  Title: Version Number

  Read Only: true

  Denotes version number of the task.

{
    "type":"object",
    "properties":{
        "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,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the higher education task row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskTypeCode":{
            "title":"Task Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.",
            "nullable":false,
            "default":"ORA_HEY_MANUAL_TASK",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "tagAssignments":{
            "title":"Task Tags",
            "type":"array",
            "description":"The task tags provide a user with a complete list of tags assigned to a task.",
            "items":{
                "$ref":"#/components/schemas/hedTaskSetups-tagAssignments-item-response"
            }
        },
        "PivotDateTimeIntervalMeaning":{
            "title":"Task Pivot Date Time Interval Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the pivot date time interval of the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"The unique identifier for the higher education task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PreferredTimeZone":{
            "title":"Preferred Time Zone",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the preferred time zone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskStatusMeaning":{
            "title":"Task Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the status of the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateCount":{
            "title":"Task Pivot Date Count",
            "type":"integer",
            "description":"The pivot date count for the higher education task. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":"50",
            "type":"string",
            "description":"The code for the higher education task.",
            "nullable":false,
            "x-queryable":true
        },
        "PivotDatePredicateCode":{
            "title":"Task Pivot Date Predicate Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the pivot date predicate of the higher education task. For example, the PivotDatePredicateCode from the following condition, 12 weeks after assigned date, is ORA_HEY_AFTER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedCount":{
            "title":"Number of Assignments",
            "type":"integer",
            "description":"The number of assignments that have been made for the higher education task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeName":{
            "title":"Status Scheme Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses.",
            "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,
            "x-queryable":true
        },
        "InstructionText":{
            "title":"Instruction Text",
            "type":"string",
            "description":"The instruction that an administrator provides for the higher education task.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InstructionTextClob"
                ]
            },
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the type of document, such as a ORA_HEY_ESSAY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme Identifier",
            "type":"integer",
            "description":"The unique identifier for a status scheme associated with the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StatusSchemeCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DueDate":{
            "title":"Task Due Date",
            "type":"string",
            "description":"The due date of the higher education task.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateTypeCode":{
            "title":"Task Pivot Date Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the pivot date type of the higher education task. For example, the PivotDateTypeCode from the following condition, 12 weeks after assigned date, is ORA_HEY_ASSIGNED_DATE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Task Institution Name",
            "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
        },
        "InstitutionId":{
            "title":"Task Institution Identifier",
            "type":"integer",
            "description":"The unique identifier for the institution where the higher education task is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "InstitutionName"
                ]
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Author's comment on the task definition.",
            "nullable":true,
            "default":"CommentsClob",
            "x-hints":{
                "dependencies":[
                    "CommentsClob"
                ]
            },
            "x-queryable":true
        },
        "TaskStatusCode":{
            "title":"Task Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the higher education task.",
            "nullable":true,
            "default":"ORA_HEY_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentTypeMeaning":{
            "title":"Document Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the type of document, such as an essay.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskTypeMeaning":{
            "title":"Task Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the type of task, such as a document submission task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Denotes version number of the task.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PivotDatePredicateMeaning":{
            "title":"Task Pivot Date Predicate Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the pivot date predicate of the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PivotDateTimeIntervalCode":{
            "title":"Task Pivot Date Time Interval Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the pivot date time interval of the higher education task. For example, the PivotDateTimeIntervalCode from the following condition, 12 weeks after assigned date, is ORA_HEY_WEEKS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PreferredTimeZoneCode":{
            "title":"Preferred Time Zone Code",
            "maxLength":"50",
            "type":"string",
            "description":"The list of values for the preferred time zone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PivotDateTypeMeaning":{
            "title":"Task Pivot Date Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the pivot date type of the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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,
            "x-queryable":true
        },
        "StatusSchemeCode":{
            "title":"Status Scheme Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status scheme code, such as a code for a group of statuses for admissions.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "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":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the higher education task row was last updated.",
            "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 : Task Tags

Type: array

Title: Task Tags

The task tags provide a user with a complete list of tags assigned to a task.

Show Source

• Array of: object hedTaskSetups-tagAssignments-item-response

{
    "title":"Task Tags",
    "type":"array",
    "description":"The task tags provide a user with a complete list of tags assigned to a task.",
    "items":{
        "$ref":"#/components/schemas/hedTaskSetups-tagAssignments-item-response"
    }
}

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."
        }
    }
}

Nested Schema : hedTaskSetups-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  Unique identifier of the tag assignment.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The unique code of a tag.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of the tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the tag assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code of a tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the tag.",
            "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"
    }
}

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

documentTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_CATEGORY_CODE

The following properties are defined on the LOV link relation:

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

pivotDatePredicatesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_DATE_TIME_PREDICATE

The following properties are defined on the LOV link relation:

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

pivotDateTimeIntervalsLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_DATE_TIME_INTERVAL

The following properties are defined on the LOV link relation:

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

pivotDateTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_DATE_TYPE

The following properties are defined on the LOV link relation:

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

preferredTimeZoneLOV

Operation: /fscmRestApi/resources/11.13.18.05/timezonesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: PreferredTimeZoneCode; Target Attribute: TimezoneCode
• Display Attribute: Name

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

studentManagementCategoriesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories

The following properties are defined on the LOV link relation:

• Source Attribute: CategoryName; Target Attribute: CategoryName
• Display Attribute: CategoryName

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedTaskSetups/{TaskId}/child/tagAssignments

Parameters:

• TaskId: $request.path.TaskId

The task tags provide a user with a complete list of tags assigned to a task.

taskStatusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TASK_STATUS

The following properties are defined on the LOV link relation:

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

taskTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TASK_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top