Get a higher education task setup
get
/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=
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 TopResponse
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.
Root Schema : hedTaskSetups-item-response
Type:
Show Source
object
-
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
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
Maximum Length:
30
The code for the type of document, such as a ORA_HEY_ESSAY. -
DocumentTypeMeaning: string
Title:
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:
Task 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
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. -
TaskCode: string
Title:
Task Code
Maximum Length:50
The code for the higher education task. -
TaskDescription: string
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
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
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:
Meaning
Read Only:true
Maximum Length:80
The meaning of the type of task, such as a document submission task. -
VersionNumber: integer
(int32)
Read Only:
true
Denotes version number of the task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- academicInstitutionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionName; Target Attribute: InstitutionName
- Display Attribute: InstitutionName
- documentTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_CATEGORY_CODE
The following properties are defined on the LOV link relation:- Source Attribute: DocumentTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- pivotDatePredicatesLOV
-
Parameters:
- finder:
LookupTypeFinder%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
- finder:
- pivotDateTimeIntervalsLOV
-
Parameters:
- finder:
LookupTypeFinder%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
- finder:
- pivotDateTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_DATE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: PivotDateTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- preferredTimeZoneLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PreferredTimeZoneCode; Target Attribute: TimezoneCode
- Display Attribute: Name
- statusSchemesLOV
-
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
- finder:
- studentManagementCategoriesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: CategoryName; Target Attribute: CategoryName
- Display Attribute: CategoryName
- taskStatusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_TASK_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: TaskStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- taskTypesLOV
-
Parameters:
- finder:
LookupTypeTagFinder%3BLookupType%3DORA_HEY_TASK_TYPE%2CTag%3DHEY_UI
The following properties are defined on the LOV link relation:- Source Attribute: TaskTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: