Create a higher education checklist setups

post

/fscmRestApi/resources/11.13.18.05/hedChecklistSetups

Request

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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : Checklist Tags
Type: array
Title: Checklist Tags
The 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: object
Show Source
Nested Schema : hedChecklistSetups-tagAssignments-item-post-request
Type: object
Show Source
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-item-response
Type: object
Show Source
  • Title: Checklist Code
    Maximum Length: 50
    The code for the higher education checklist.
  • Title: Checklist Description
    Maximum Length: 240
    The description that an administrator provides for the higher education checklist.
  • Title: Checklist Identifier
    Read Only: true
    The unique identifier for the higher education checklist.
  • Title: Checklist Name
    Maximum Length: 50
    The name that an administrator provides for the higher education checklist.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the row for the higher education checklist.
  • Title: Creation Date
    Read Only: true
    The date and time when the higher education checklist row was created.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the higher education checklist row was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the row for the higher education checklist.
  • Links
  • Title: Predefined Indicator
    Read Only: true
    Default Value: 0
    Indicates 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.
  • Checklist Tags
    Title: Checklist Tags
    The checklist tags provide a user with a complete list of tags assigned to a checklist.
  • Title: Task Count
    Read Only: true
    The number of tasks that have been added to the higher education 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 : Checklist Tags
Type: array
Title: Checklist Tags
The checklist tags provide a user with a complete list of tags assigned to a checklist.
Show Source
Nested Schema : hedChecklistSetups-checklistTasks-item-response
Type: object
Show Source
Nested Schema : hedChecklistSetups-tagAssignments-item-response
Type: object
Show Source
Back to Top