Get all higher education checklist tasks

get

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

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all higher education checklist tasks that match the primary key criteria specified.
      Finder Variables
      • ChecklistTaskId; integer; Unique identifier for the higher education checklist task.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CategoryId; integer; The unique identifier for the category where the higher education task is created.
    • CategoryName; string; The name of the category where the higher education task is created.
    • ChecklistTaskId; integer; The unique identifier for the higher education checklist task.
    • CreatedBy; string; The date and time when the higher education task row was created.
    • CreationDate; string; The user who created the row for the higher education task.
    • DisplaySequence; integer; The sequence for the higher education checklist task.
    • DueDate; string; The due date of the higher education checklist task.
    • InstitutionId; integer; The unique identifier for the institution where the higher education task is created.
    • InstitutionName; string; The name of the institution where the higher education task is created.
    • LastUpdateBy; string; The user who last updated the row for the higher education task.
    • LastUpdateDate; string; The date and time when the higher education task row was last updated.
    • PivotDateCount; integer; 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; 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; The meaning of the pivot date predicate of the higher education task.
    • PivotDateTimeIntervalCode; string; 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; The meaning of the pivot date time interval of the higher education task.
    • PivotDateTypeCode; string; 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; The meaning of the pivot date type of the higher education checklist.
    • PreferredTimeZone; string; The name of the preferred time zone.
    • PreferredTimeZoneCode; string; The preferred time zone code used to display the due date during setup.
    • StatusSchemeCode; string; The status scheme code, such as a code for a group of statuses for admissions.
    • StatusSchemeId; integer; The unique identifier for a status scheme associated with the task.
    • StatusSchemeName; string; The name of the status scheme, such as admissions statuses.
    • TaskCode; string; The code for the higher education task.
    • TaskDescription; string; The description that an administrator provides for the higher education task.
    • TaskId; integer; The unique identifier for the higher education task.
    • TaskName; string; The name that an administrator provides for the higher education task.
    • TaskTypeCode; string; The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.
    • TaskTypeMeaning; string; The meaning of the type of task, such as a document submission task.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : hedChecklistSetups-checklistTasks-item-response
Type: object
Show Source
  • Title: Task Category Identifier
    Read Only: true
    The unique identifier for the category where the higher education task is created.
  • Title: Category Name
    Read Only: true
    Maximum Length: 50
    The name of the category where the higher education task is created.
  • Title: Checklist Task Identifier
    Read Only: true
    The unique identifier for the higher education checklist task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The date and time when the higher education task row was created.
  • Title: Creation Date
    Read Only: true
    The user who created the row for the higher education task.
  • Title: Checklist Task Meaning
    Default Value: 1
    The sequence for the higher education checklist task.
  • Title: Task Due Date
    Read Only: true
    The due date of the higher education checklist task.
  • Title: Task Institution Identifier
    Read Only: true
    The unique identifier for the institution where the higher education task is created.
  • Title: Task Institution Name
    Read Only: true
    Maximum Length: 50
    The name of the institution where the higher education task is created.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the row for the higher education task.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the higher education task row was last updated.
  • Links
  • 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.
  • 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.
  • Title: Task Pivot Date Predicate Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the pivot date predicate of the higher education task.
  • 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.
  • 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.
  • 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.
  • Title: Task Pivot Date Type Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the pivot date type of the higher education checklist.
  • Title: Preferred Time Zone
    Read Only: true
    Maximum Length: 80
    The name of the preferred time zone.
  • Title: Preferred Time Zone Code
    Read Only: true
    Maximum Length: 50
    The preferred time zone code used to display the due date during setup.
  • Read Only: true
    Maximum Length: 30
    The status scheme code, such as a code for a group of statuses for admissions.
  • Read Only: true
    The unique identifier for a status scheme associated with the task.
  • Read Only: true
    Maximum Length: 60
    The name of the status scheme, such as admissions statuses.
  • Title: Task Code
    Read Only: true
    Maximum Length: 50
    The code for the higher education task.
  • Title: Task Description
    Read Only: true
    Maximum Length: 240
    The description that an administrator provides for the higher education task.
  • Title: Task Identifier
    The unique identifier for the higher education task.
  • Title: Task Name
    Read Only: true
    Maximum Length: 50
    The name that an administrator provides for the higher education task.
  • Read Only: true
    Maximum Length: 30
    The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the type of task, such as a document submission task.
Back to Top