Create a higher education checklist setups
post
/fscmRestApi/resources/11.13.18.05/hedChecklistSetups
Request
Header Parameters
-
Metadata-Context: string
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: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ChecklistCode(required): string
Title:
Checklist CodeMaximum Length:50The code for the higher education checklist. -
ChecklistDescription: string
Title:
Checklist DescriptionMaximum Length:240The description that an administrator provides for the higher education checklist. -
ChecklistName(required): string
Title:
Checklist NameMaximum Length:50The name that an administrator provides for the higher education checklist. -
checklistTasks: array
HED Checklist Tasks
Title:
HED Checklist TasksThe 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. -
tagAssignments: array
Checklist Tags
Title:
Checklist TagsThe checklist tags provide a user with a complete list of tags assigned to a checklist.
Nested Schema : HED Checklist Tasks
Type:
arrayTitle:
HED Checklist TasksThe 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 : Checklist Tags
Type:
arrayTitle:
Checklist TagsThe checklist tags provide a user with a complete list of tags assigned to a checklist.
Show Source
Nested Schema : hedChecklistSetups-checklistTasks-item-post-request
Type:
Show Source
object-
DisplaySequence: integer
(int32)
Title:
Display SequenceDefault Value:1The sequence for the higher education checklist task. -
TaskHeaderId: integer
(int64)
Title:
Task Header IdentifierThe unique identifier for the higher education task header.
Nested Schema : hedChecklistSetups-tagAssignments-item-post-request
Type:
Show Source
object-
TagCode: string
Title:
Tag CodeMaximum Length:30The unique code of a tag. -
TagId: integer
(int64)
Title:
Tag IDUnique identifier of the tag.
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.
Root Schema : hedChecklistSetups-item-response
Type:
Show Source
object-
ChecklistCode: string
Title:
Checklist CodeMaximum Length:50The code for the higher education checklist. -
ChecklistDescription: string
Title:
Checklist DescriptionMaximum Length:240The description that an administrator provides for the higher education checklist. -
ChecklistId: integer
(int64)
Title:
Checklist IdentifierRead Only:trueThe unique identifier for the higher education checklist. -
ChecklistName: string
Title:
Checklist NameMaximum Length:50The name that an administrator provides for the higher education checklist. -
checklistTasks: array
HED Checklist Tasks
Title:
HED Checklist TasksThe 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. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the row for the higher education checklist. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the higher education checklist row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the higher education checklist row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the row for the higher education checklist. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SeedDataLock: integer
(int32)
Title:
Predefined IndicatorRead Only:trueDefault Value:0Indicates whether the row is predefined. The value 0 means the row isn't predefined. The value 1 means the row is predefined and can't be updated, but can be disabled. -
tagAssignments: array
Checklist Tags
Title:
Checklist TagsThe checklist tags provide a user with a complete list of tags assigned to a checklist. -
TaskCount: integer
Title:
Task CountRead Only:trueThe number of tasks that have been added to the higher education checklist.
Nested Schema : HED Checklist Tasks
Type:
arrayTitle:
HED Checklist TasksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Checklist Tags
Type:
arrayTitle:
Checklist TagsThe checklist tags provide a user with a complete list of tags assigned to a checklist.
Show Source
Nested Schema : hedChecklistSetups-checklistTasks-item-response
Type:
Show Source
object-
ChecklistTaskId: integer
(int64)
Title:
Checklist Task IdentifierRead Only:trueThe unique identifier for the higher education checklist task. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The date and time when the higher education task row was created. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe user who created the row for the higher education task. -
DisplaySequence: integer
(int32)
Title:
Display SequenceDefault Value:1The sequence for the higher education checklist task. -
LastUpdateBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the row for the higher education task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the higher education task row was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TaskCode: string
Title:
Task CodeRead Only:trueMaximum Length:50The code for the higher education task. -
TaskHeaderId: integer
(int64)
Title:
Task Header IdentifierThe unique identifier for the higher education task header. -
TaskName: string
Title:
Task NameRead Only:trueMaximum Length:50The name that an administrator provides for the higher education task. -
VersionStatusCode: string
Title:
Status CodeRead Only:trueMaximum Length:30Status code of the most relevant task version. -
VersionStatusMeaning: string
Title:
StatusRead Only:trueMaximum Length:80Status of the most relevant task version.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : hedChecklistSetups-tagAssignments-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TagAssignmentId: integer
(int64)
Title:
Tag Assignment IDRead Only:trueUnique identifier of the tag assignment. -
TagCode: string
Title:
Tag CodeMaximum Length:30The unique code of a tag. -
TagId: integer
(int64)
Title:
Tag IDUnique identifier of the tag. -
TagName: string
Title:
Tag NameRead Only:trueMaximum Length:64The name of the tag.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- 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:
- tagAssignments
-
Parameters:
- ChecklistId:
$request.path.ChecklistId
The checklist tags provide a user with a complete list of tags assigned to a checklist. - ChecklistId: