Jump to

• Request
• Response

Create a higher education checklist setups

post

/fscmRestApi/resources/11.13.18.05/hedChecklistSetups

Request

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.
• Upsert-Mode:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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
  Title: Checklist Description

  Maximum Length: 240

  The description that an administrator provides for the higher education checklist.
• ChecklistName(required): string
  Title: Checklist Name

  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
  Title: Comments

  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.
• tagAssignments: array Checklist Tags
  Title: Checklist Tags

  The checklist tags provide a user with a complete list of tags assigned to a checklist.

{
    "required":[
        "ChecklistCode",
        "ChecklistName"
    ],
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Checklist Category Identifier",
            "type":"integer",
            "description":"The unique identifier for the category where the higher education checklist is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PivotDateTypeCode":{
            "title":"Checklist Pivot Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "tagAssignments":{
            "title":"Checklist Tags",
            "type":"array",
            "description":"The checklist tags provide a user with a complete list of tags assigned to a checklist.",
            "items":{
                "$ref":"#/components/schemas/hedChecklistSetups-tagAssignments-item-post-request"
            }
        },
        "InstitutionName":{
            "title":"Checklist Institution Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution where the higher education checklist is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstitutionId":{
            "title":"Checklist Institution Identifier",
            "type":"integer",
            "description":"The unique identifier for the institution where the higher education checklist is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Author's comment on the checklist definition.",
            "nullable":true,
            "default":"CommentsClob",
            "x-hints":{
                "dependencies":[
                    "CommentsClob"
                ]
            }
        },
        "ChecklistStatusCode":{
            "title":"Checklist Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code for the higher education checklist.",
            "nullable":false,
            "default":"ORA_HEY_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChecklistCode":{
            "title":"Checklist Code",
            "maxLength":50,
            "type":"string",
            "description":"The code for the higher education checklist.",
            "nullable":false
        },
        "PivotDateCount":{
            "title":"Checklist Pivot Date Count",
            "type":"integer",
            "description":"The pivot date count for the higher education checklist. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "ChecklistName":{
            "title":"Checklist Name",
            "maxLength":50,
            "type":"string",
            "description":"The name that an administrator provides for the higher education checklist.",
            "nullable":false
        },
        "PivotDatePredicateCode":{
            "title":"Checklist Pivot Date Predicate Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PivotDateTimeIntervalCode":{
            "title":"Checklist Pivot Date Time Interval Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PreferredTimeZoneCode":{
            "title":"Preferred Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"The preferred time zone code used to display the due date during setup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstructionText":{
            "title":"Checklist Instruction Text",
            "type":"string",
            "description":"The instruction that an administrator provides for the higher education checklist.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InstructionTextClob"
                ]
            }
        },
        "checklistTasks":{
            "title":"HED Checklist Tasks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hedChecklistSetups-checklistTasks-item-post-request"
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the category where the higher education checklist is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChecklistDescription":{
            "title":"Checklist Description",
            "maxLength":240,
            "type":"string",
            "description":"The description that an administrator provides for the higher education checklist.",
            "nullable":true
        },
        "DueDate":{
            "title":"Checklist Due Date",
            "type":"string",
            "description":"The due date of the higher education checklist.",
            "format":"date-time",
            "nullable":true
        }
    }
}

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

• Array of: object hedChecklistSetups-checklistTasks-item-post-request

{
    "title":"HED Checklist Tasks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hedChecklistSetups-checklistTasks-item-post-request"
    }
}

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

• Array of: object hedChecklistSetups-tagAssignments-item-post-request

{
    "title":"Checklist Tags",
    "type":"array",
    "description":"The checklist tags provide a user with a complete list of tags assigned to a checklist.",
    "items":{
        "$ref":"#/components/schemas/hedChecklistSetups-tagAssignments-item-post-request"
    }
}

Nested Schema : hedChecklistSetups-checklistTasks-item-post-request

Type: object

Show Source

• DisplaySequence: integer (int32)
  Title: Checklist Task Meaning

  Default Value: 1

  The sequence for the higher education checklist task.
• TaskId: integer (int64)
  Title: Task Identifier

  The unique identifier for the higher education task.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "title":"Checklist Task Meaning",
            "type":"integer",
            "description":"The sequence for the higher education checklist task.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":5
            }
        },
        "TaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"The unique identifier for the higher education task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : hedChecklistSetups-tagAssignments-item-post-request

Type: object

Show Source

• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The unique code of a tag.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code of a tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : hedChecklistSetups-item-response

Type: object

Show Source

• 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
  Title: Checklist Description

  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
  Title: Checklist Name

  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
  Title: Comments

  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.
• tagAssignments: array Checklist Tags
  Title: Checklist Tags

  The checklist tags provide a user with a complete list of tags assigned to a checklist.
• TaskCount: integer
  Title: Task Count

  Read Only: true

  The number of tasks that have been added to the higher education checklist.
• VersionNumber: integer (int32)
  Title: Version Number

  Read Only: true

  Denotes version number of the checklist.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Checklist Category Identifier",
            "type":"integer",
            "description":"The unique identifier for the category where the higher education checklist is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the higher education checklist row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "tagAssignments":{
            "title":"Checklist Tags",
            "type":"array",
            "description":"The checklist tags provide a user with a complete list of tags assigned to a checklist.",
            "items":{
                "$ref":"#/components/schemas/hedChecklistSetups-tagAssignments-item-response"
            }
        },
        "PivotDateTimeIntervalMeaning":{
            "title":"Checklist Pivot Date Time Interval Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the pivot date time interval of the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredTimeZone":{
            "title":"Preferred Time Zone",
            "maxLength":80,
            "type":"string",
            "description":"The name of the preferred time zone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCount":{
            "title":"Task Count",
            "type":"integer",
            "description":"The number of tasks that have been added to the higher education checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist Identifier",
            "type":"integer",
            "description":"The unique identifier for the higher education checklist.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChecklistCode":{
            "title":"Checklist Code",
            "maxLength":50,
            "type":"string",
            "description":"The code for the higher education checklist.",
            "nullable":false,
            "x-queryable":true
        },
        "PivotDateCount":{
            "title":"Checklist Pivot Date Count",
            "type":"integer",
            "description":"The pivot date count for the higher education checklist. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ChecklistName":{
            "title":"Checklist Name",
            "maxLength":50,
            "type":"string",
            "description":"The name that an administrator provides for the higher education checklist.",
            "nullable":false,
            "x-queryable":true
        },
        "PivotDatePredicateCode":{
            "title":"Checklist Pivot Date Predicate Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignedCount":{
            "title":"Number of Assignments",
            "type":"integer",
            "description":"The number of assignments that have been made for the higher education checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionText":{
            "title":"Checklist Instruction Text",
            "type":"string",
            "description":"The instruction that an administrator provides for the higher education checklist.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InstructionTextClob"
                ]
            },
            "x-queryable":true
        },
        "checklistTasks":{
            "title":"HED Checklist Tasks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hedChecklistSetups-checklistTasks-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChecklistDescription":{
            "title":"Checklist Description",
            "maxLength":240,
            "type":"string",
            "description":"The description that an administrator provides for the higher education checklist.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Checklist Due Date",
            "type":"string",
            "description":"The due date of the higher education checklist.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateTypeCode":{
            "title":"Checklist Pivot Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row for the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Checklist Institution Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution where the higher education checklist is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Checklist Institution Identifier",
            "type":"integer",
            "description":"The unique identifier for the institution where the higher education checklist is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Author's comment on the checklist definition.",
            "nullable":true,
            "default":"CommentsClob",
            "x-hints":{
                "dependencies":[
                    "CommentsClob"
                ]
            },
            "x-queryable":true
        },
        "ChecklistStatusMeaning":{
            "title":"Checklist Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the higher education checklist status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistStatusCode":{
            "title":"Checklist Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code for the higher education checklist.",
            "nullable":false,
            "default":"ORA_HEY_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Denotes version number of the checklist.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PivotDatePredicateMeaning":{
            "title":"Checklist Pivot Date Predicate Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the pivot date predicate of the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateTimeIntervalCode":{
            "title":"Checklist Pivot Date Time Interval Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferredTimeZoneCode":{
            "title":"Preferred Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"The preferred time zone code used to display the due date during setup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PivotDateTypeMeaning":{
            "title":"Checklist Pivot Date Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the pivot date type of the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the category where the higher education checklist is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the higher education checklist row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object hedChecklistSetups-checklistTasks-item-response

{
    "title":"HED Checklist Tasks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hedChecklistSetups-checklistTasks-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object hedChecklistSetups-tagAssignments-item-response

{
    "title":"Checklist Tags",
    "type":"array",
    "description":"The checklist tags provide a user with a complete list of tags assigned to a checklist.",
    "items":{
        "$ref":"#/components/schemas/hedChecklistSetups-tagAssignments-item-response"
    }
}

Nested Schema : hedChecklistSetups-checklistTasks-item-response

Type: object

Show Source

• 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
  Title: Status Scheme Code

  Read Only: true

  Maximum Length: 30

  The status scheme code, such as a code for a group of statuses for admissions.
• StatusSchemeId: integer (int64)
  Title: Status Scheme Identifier

  Read Only: true

  The unique identifier for a status scheme associated with the task.
• StatusSchemeName: string
  Title: Status Scheme Name

  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
  Title: Task Type Code

  Read Only: true

  Maximum Length: 30

  The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.
• TaskTypeMeaning: string
  Title: Task Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the type of task, such as a document submission task.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Task Category Identifier",
            "type":"integer",
            "description":"The unique identifier for the category where the higher education task is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskTypeCode":{
            "title":"Task Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The user who created the row for the higher education task.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateTimeIntervalMeaning":{
            "title":"Task Pivot Date Time Interval Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the pivot date time interval of the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"The unique identifier for the higher education task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredTimeZone":{
            "title":"Preferred Time Zone",
            "maxLength":80,
            "type":"string",
            "description":"The name of the preferred time zone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Checklist Task Meaning",
            "type":"integer",
            "description":"The sequence for the higher education checklist task.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ChecklistTaskId":{
            "title":"Checklist Task Identifier",
            "type":"integer",
            "description":"The unique identifier for the higher education checklist task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PivotDateCount":{
            "title":"Task Pivot Date Count",
            "type":"integer",
            "description":"The pivot date count for the higher education task. For example, the PivotDateCount from the following condition, 12 weeks after assigned date, is 12.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":50,
            "type":"string",
            "description":"The code for the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDatePredicateCode":{
            "title":"Task Pivot Date Predicate Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskDescription":{
            "title":"Task Description",
            "maxLength":240,
            "type":"string",
            "description":"The description that an administrator provides for the higher education task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeName":{
            "title":"Status Scheme Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme Identifier",
            "type":"integer",
            "description":"The unique identifier for a status scheme associated with the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DueDate":{
            "title":"Task Due Date",
            "type":"string",
            "description":"The due date of the higher education checklist task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateTypeCode":{
            "title":"Task Pivot Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the higher education task row was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Task Institution Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution where the higher education task is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Task Institution Identifier",
            "type":"integer",
            "description":"The unique identifier for the institution where the higher education task is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskTypeMeaning":{
            "title":"Task Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of task, such as a document submission task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PivotDatePredicateMeaning":{
            "title":"Task Pivot Date Predicate Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the pivot date predicate of the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateTimeIntervalCode":{
            "title":"Task Pivot Date Time Interval Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredTimeZoneCode":{
            "title":"Preferred Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"The preferred time zone code used to display the due date during setup.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":50,
            "type":"string",
            "description":"The name that an administrator provides for the higher education task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PivotDateTypeMeaning":{
            "title":"Task Pivot Date Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the pivot date type of the higher education checklist.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusSchemeCode":{
            "title":"Status Scheme Code",
            "maxLength":30,
            "type":"string",
            "description":"The status scheme code, such as a code for a group of statuses for admissions.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the category where the higher education task is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the higher education task row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedChecklistSetups-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  Unique identifier of the tag assignment.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The unique code of a tag.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of the tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the tag assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code of a tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

academicInstitutionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionName; Target Attribute: InstitutionName
• Display Attribute: InstitutionName

checklistPreferredTimeZoneLOV

Operation: /fscmRestApi/resources/11.13.18.05/timezonesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: PreferredTimeZoneCode; Target Attribute: TimezoneCode
• Display Attribute: Name

checklistStatusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TASK_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: ChecklistStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

checklistTasks

Operation: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/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.

pivotDatePredicatesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%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

pivotDateTimeIntervalsLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%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

pivotDateTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_DATE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: PivotDateTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

studentManagementCategoriesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories

The following properties are defined on the LOV link relation:

• Source Attribute: CategoryName; Target Attribute: CategoryName
• Display Attribute: CategoryName

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedChecklistSetups/{ChecklistId}/child/tagAssignments

Parameters:

• ChecklistId: $request.path.ChecklistId

The checklist tags provide a user with a complete list of tags assigned to a checklist.

Back to Top