Update a higher education checklist setup
patch
/fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}
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=
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
Root Schema : schema
Type:
Show Source
object
-
CategoryId: integer
(int64)
Title:
Checklist Category Identifier
The unique identifier for the category where the higher education checklist is created. -
CategoryName: string
Title:
Category Name
Maximum Length:50
The name of the category where the higher education checklist is created. -
ChecklistCode(required): string
Title:
Checklist Code
Maximum Length:50
The code for the higher education checklist. -
ChecklistDescription: string
Maximum Length:
240
The description that an administrator provides for the higher education checklist. -
ChecklistName(required): string
Maximum Length:
50
The name that an administrator provides for the higher education checklist. -
ChecklistStatusCode: string
Title:
Checklist Status Code
Maximum Length:30
Default Value:ORA_HEY_DRAFT
The status code for the higher education checklist. -
checklistTasks: array
HED Checklist Tasks
Title:
HED Checklist Tasks
The HED checklist tasks resource is a child of the HED checklist setups resource and provides a complete list of tasks added to a checklist setup. -
Comments: string
Default Value:
CommentsClob
Author's comment on the checklist definition. -
DueDate: string
(date-time)
Title:
Checklist Due Date
The due date of the higher education checklist. -
InstitutionId: integer
(int64)
Title:
Checklist Institution Identifier
The unique identifier for the institution where the higher education checklist is created. -
InstitutionName: string
Title:
Checklist Institution Name
Maximum Length:50
The name of the institution where the higher education checklist is created. -
InstructionText: string
Title:
Checklist Instruction Text
The instruction that an administrator provides for the higher education checklist. -
PivotDateCount: integer
(int32)
Title:
Checklist Pivot Date Count
The pivot date count for the higher education checklist. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12. -
PivotDatePredicateCode: string
Title:
Checklist Pivot Date Predicate Code
Maximum Length:30
The code for the pivot date predicate of the higher education checklist. For example, the PivotDatePredicateCode from the following condition, 12 weeks after assigned date, is ORA_HEY_AFTER. -
PivotDateTimeIntervalCode: string
Title:
Checklist Pivot Date Time Interval Code
Maximum Length:30
The code for the pivot date time interval of the higher education checklist. For example, the PivotDateIntervalCode from the following condition, 12 weeks after assigned date, is ORA_HEY_WEEKS. -
PivotDateTypeCode: string
Title:
Checklist Pivot Date Type Code
Maximum Length:30
The code for the pivot date type of the higher education checklist. 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 preferred time zone code used to display the due date during setup.
Nested Schema : HED Checklist Tasks
Type:
array
Title:
HED Checklist Tasks
The HED checklist tasks resource is a child of the HED checklist setups resource and provides a complete list of tasks added to a checklist setup.
Show Source
Nested Schema : hedChecklistSetups-checklistTasks-item-patch-request
Type:
Show Source
object
-
DisplaySequence: integer
(int32)
Title:
Checklist Task Meaning
Default Value:1
The sequence for the higher education checklist task.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : hedChecklistSetups-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 checklist. -
CategoryId: integer
(int64)
Title:
Checklist Category Identifier
The unique identifier for the category where the higher education checklist is created. -
CategoryName: string
Title:
Category Name
Maximum Length:50
The name of the category where the higher education checklist is created. -
ChecklistCode: string
Title:
Checklist Code
Maximum Length:50
The code for the higher education checklist. -
ChecklistDescription: string
Maximum Length:
240
The description that an administrator provides for the higher education checklist. -
ChecklistId: integer
(int64)
Title:
Checklist Identifier
Read Only:true
The unique identifier for the higher education checklist. -
ChecklistName: string
Maximum Length:
50
The name that an administrator provides for the higher education checklist. -
ChecklistStatusCode: string
Title:
Checklist Status Code
Maximum Length:30
Default Value:ORA_HEY_DRAFT
The status code for the higher education checklist. -
ChecklistStatusMeaning: string
Title:
Checklist Status Meaning
Read Only:true
Maximum Length:80
The meaning of the higher education checklist status. -
checklistTasks: array
HED Checklist Tasks
Title:
HED Checklist Tasks
The HED checklist tasks resource is a child of the HED checklist setups resource and provides a complete list of tasks added to a checklist setup. -
Comments: string
Default Value:
CommentsClob
Author's comment on the checklist definition. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row for the higher education checklist. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the higher education checklist row was created. -
DueDate: string
(date-time)
Title:
Checklist Due Date
The due date of the higher education checklist. -
InstitutionId: integer
(int64)
Title:
Checklist Institution Identifier
The unique identifier for the institution where the higher education checklist is created. -
InstitutionName: string
Title:
Checklist Institution Name
Maximum Length:50
The name of the institution where the higher education checklist is created. -
InstructionText: string
Title:
Checklist Instruction Text
The instruction that an administrator provides for the higher education checklist. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the higher education checklist 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 checklist. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PivotDateCount: integer
(int32)
Title:
Checklist Pivot Date Count
The pivot date count for the higher education checklist. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12. -
PivotDatePredicateCode: string
Title:
Checklist Pivot Date Predicate Code
Maximum Length:30
The code for the pivot date predicate of the higher education checklist. For example, the PivotDatePredicateCode from the following condition, 12 weeks after assigned date, is ORA_HEY_AFTER. -
PivotDatePredicateMeaning: string
Title:
Checklist Pivot Date Predicate Meaning
Read Only:true
Maximum Length:80
The meaning of the pivot date predicate of the higher education checklist. -
PivotDateTimeIntervalCode: string
Title:
Checklist Pivot Date Time Interval Code
Maximum Length:30
The code for the pivot date time interval of the higher education checklist. For example, the PivotDateIntervalCode from the following condition, 12 weeks after assigned date, is ORA_HEY_WEEKS. -
PivotDateTimeIntervalMeaning: string
Title:
Checklist Pivot Date Time Interval Meaning
Read Only:true
Maximum Length:80
The meaning of the pivot date time interval of the higher education checklist. -
PivotDateTypeCode: string
Title:
Checklist Pivot Date Type Code
Maximum Length:30
The code for the pivot date type of the higher education checklist. For example, the PivotDateTypeCode from the following condition, 12 weeks after assigned date, is ORA_HEY_ASSIGNED_DATE. -
PivotDateTypeMeaning: string
Title:
Checklist 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
Maximum Length:50
The preferred time zone code used to display the due date during setup. -
TaskCount: integer
Read Only:
true
The number of tasks that have been added to the higher education checklist. -
VersionNumber: integer
(int32)
Read Only:
true
Denotes version number of the checklist.
Nested Schema : HED Checklist Tasks
Type:
array
Title:
HED Checklist Tasks
The HED checklist tasks resource is a child of the HED checklist setups resource and provides a complete list of tasks added to a checklist setup.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedChecklistSetups-checklistTasks-item-response
Type:
Show Source
object
-
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
Read Only:
true
Maximum Length:30
The status scheme code, such as a code for a group of statuses for admissions. -
StatusSchemeId: integer
(int64)
Read Only:
true
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
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
Read Only:
true
Maximum Length:30
The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION. -
TaskTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the type of task, such as a document submission task.
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
- checklistPreferredTimeZoneLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PreferredTimeZoneCode; Target Attribute: TimezoneCode
- Display Attribute: Name
- checklistStatusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_TASK_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: ChecklistStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- checklistTasks
-
Parameters:
- ChecklistId:
$request.path.ChecklistId
The HED checklist tasks resource is a child of the HED checklist setups resource and provides a complete list of tasks added to a checklist setup. - ChecklistId:
- 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:
- studentManagementCategoriesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: CategoryName; Target Attribute: CategoryName
- Display Attribute: CategoryName