Jump to

• Request
• Response

Get a higher education checklist task

get

/fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/checklistTasks/{ChecklistTaskId}

Request

Path Parameters

• ChecklistId(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=
• ChecklistTaskId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : hedChecklistSetups-checklistTasks-item-response

Type: object

Show Source

• 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.
• ChecklistTaskId: integer (int64)
  Title: Checklist Task Identifier

  Read Only: true

  The unique identifier for the higher education checklist task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The date and time when the higher education task row was created.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The user who created the row for the higher education task.
• DisplaySequence: integer (int32)
  Title: Checklist Task Meaning

  Default Value: 1

  The sequence for the higher education checklist task.
• DueDate: string (date-time)
  Title: Task Due Date

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

  The name of the institution where the higher education task is created.
• LastUpdateBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row 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.
• links: array Links
  Title: Links

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

  Read Only: true

  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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 30

  The code for the pivot date time interval of the higher education task. For example, the PivotDateIntervalCode 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

  Read Only: true

  Maximum Length: 30

  The code for the pivot date type of the higher education task. For example, the PivotDatePredicateCode 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 checklist.
• 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

  Read Only: true

  Maximum Length: 50

  The preferred time zone code used to display the due date during setup.
• StatusSchemeCode: string
  Title: Status Scheme Code

  Read Only: true

  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

  Read Only: true

  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.
• TaskCode: string
  Title: Task Code

  Read Only: true

  Maximum Length: 50

  The code for the higher education task.
• 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
  Title: Task Type Code

  Read Only: true

  Maximum Length: 30

  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.

{
    "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The user who created the row for the higher education task.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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-queryable":true
        },
        "LastUpdateBy":{
            "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
        },
        "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
        },
        "PreferredTimeZone":{
            "title":"Preferred Time Zone",
            "maxLength":80,
            "type":"string",
            "description":"The name of the preferred time zone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Checklist Task Meaning",
            "type":"integer",
            "description":"The sequence for the higher education checklist task.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ChecklistTaskId":{
            "title":"Checklist Task Identifier",
            "type":"integer",
            "description":"The unique identifier for the higher education checklist task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":50,
            "type":"string",
            "description":"The code for the higher education task.",
            "nullable":false,
            "readOnly":true,
            "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,
            "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":{
            "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
        },
        "StatusSchemeId":{
            "title":"Status Scheme Identifier",
            "type":"integer",
            "description":"The unique identifier for a status scheme associated with the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":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"
            }
        },
        "DueDate":{
            "title":"Task Due Date",
            "type":"string",
            "description":"The due date of the higher education checklist task.",
            "format":"date-time",
            "nullable":true,
            "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 PivotDatePredicateCode from the following condition, 12 weeks after assigned date, is ORA_HEY_ASSIGNED_DATE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the higher education task row was created.",
            "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":false,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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-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 PivotDateIntervalCode from the following condition, 12 weeks after assigned date, is ORA_HEY_WEEKS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredTimeZoneCode":{
            "title":"Preferred Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"The preferred time zone code used to display the due date during setup.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "PivotDateTypeMeaning":{
            "title":"Task Pivot Date Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the pivot date type of the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "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,
            "readOnly":true,
            "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":false,
            "readOnly":true,
            "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 : 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

hedWorkflowStatusSchemesLOV

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

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

Back to Top