Jump to

• Request
• Response

Create a waitlist setting

post

/fscmRestApi/resources/11.13.18.05/waitlistSettings

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

• assignments: array Waitlist Settings Assignments
  Title: Waitlist Settings Assignments

  The assignments resource is used to list the academic entities assigned to the waitlist settings.
• DefaultWaitlistCapacity: integer (int32)
  Title: Default Waitlist Capacity

  Default Value: 0

  The default capacity of the waitlist.
• DropWLSectionsAfterEnrollFlag: boolean
  Title: Drop Waitlisted Sections After Enrollment

  Maximum Length: 1

  Default Value: false

  Indicates that the student will be dropped from the waitlist of other sections of a course after they have successfully enrolled in any sections for that course.
• ExpiredInvitationActionCode: string
  Title: Expired Invitation Action Code

  Maximum Length: 30

  The expired invitation action code. A list of accepted values is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION.
• InvitationResponseHours: integer (int32)
  Title: Invitation Response Hours

  Default Value: 0

  The invitation response hours of the waitlist setting documenting how long a student has to respond to an open seat notification.
• MaximumControlTypeCode: string
  Title: Maximum Waitlist Control Type Code

  Maximum Length: 30

  The maximum waitlist control type code. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE.
• MaximumControlUnits: integer (int32)
  Title: Maximum Waitlist Control Units

  Default Value: 0

  The maximum number of control units that limits a student's ability to waitlist after this number is reached.
• OwningEntityId(required): integer (int64)
  Title: Owning Entity ID

  The unique identifier of the owning entity.
• OwningEntityTypeCode(required): string
  Title: Owning Entity Type Code

  Maximum Length: 30

  The entity type code of the owning entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• WaitlistingEnabledFlag: boolean
  Title: Waitlisting Enabled

  Maximum Length: 1

  Default Value: false

  Indicates that the waitlist setting is enabled.

{
    "required":[
        "OwningEntityId",
        "OwningEntityTypeCode"
    ],
    "type":"object",
    "properties":{
        "OwningEntityTypeCode":{
            "title":"Owning Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the owning entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "assignments":{
            "title":"Waitlist Settings Assignments",
            "type":"array",
            "description":"The assignments resource is used to list the academic entities assigned to the waitlist settings.",
            "items":{
                "$ref":"#/components/schemas/waitlistSettings-assignments-item-post-request"
            }
        },
        "WaitlistingEnabledFlag":{
            "title":"Waitlisting Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the waitlist setting is enabled.",
            "nullable":false,
            "default":false
        },
        "MaximumControlTypeCode":{
            "title":"Maximum Waitlist Control Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The maximum waitlist control type code. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwningEntityId":{
            "title":"Owning Entity ID",
            "type":"integer",
            "description":"The unique identifier of the owning entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InvitationResponseHours":{
            "title":"Invitation Response Hours",
            "type":"integer",
            "description":"The invitation response hours of the waitlist setting documenting how long a student has to respond to an open seat notification.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            }
        },
        "DropWLSectionsAfterEnrollFlag":{
            "title":"Drop Waitlisted Sections After Enrollment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the student will be dropped from the waitlist of other sections of a course after they have successfully enrolled in any sections for that course.",
            "nullable":false,
            "default":false
        },
        "ExpiredInvitationActionCode":{
            "title":"Expired Invitation Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"The expired invitation action code. A list of accepted values is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MaximumControlUnits":{
            "title":"Maximum Waitlist Control Units",
            "type":"integer",
            "description":"The maximum number of control units that limits a student's ability to waitlist after this number is reached.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            }
        },
        "DefaultWaitlistCapacity":{
            "title":"Default Waitlist Capacity",
            "type":"integer",
            "description":"The default capacity of the waitlist.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

Nested Schema : Waitlist Settings Assignments

Type: array

Title: Waitlist Settings Assignments

The assignments resource is used to list the academic entities assigned to the waitlist settings.

Show Source

• Array of: object waitlistSettings-assignments-item-post-request

{
    "title":"Waitlist Settings Assignments",
    "type":"array",
    "description":"The assignments resource is used to list the academic entities assigned to the waitlist settings.",
    "items":{
        "$ref":"#/components/schemas/waitlistSettings-assignments-item-post-request"
    }
}

Nested Schema : waitlistSettings-assignments-item-post-request

Type: object

Show Source

• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignmentMethodCode: string
  Title: Assignment Method Code

  Maximum Length: 30

  Default Value: ORA_DIRECT

  The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• RelatedEntityId: integer (int64)
  Title: Related Entity ID

  The unique identifier of the related entity.
• RelatedEntityTypeCode: string
  Title: Related Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.

{
    "type":"object",
    "properties":{
        "RelatedEntityTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedEntityId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignmentMethodCode":{
            "title":"Assignment Method Code",
            "maxLength":"30",
            "type":"string",
            "description":"The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : waitlistSettings-item-response

Type: object

Show Source

• assignments: array Waitlist Settings Assignments
  Title: Waitlist Settings Assignments

  The assignments resource is used to list the academic entities assigned to the waitlist settings.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• DefaultWaitlistCapacity: integer (int32)
  Title: Default Waitlist Capacity

  Default Value: 0

  The default capacity of the waitlist.
• DropWLSectionsAfterEnrollFlag: boolean
  Title: Drop Waitlisted Sections After Enrollment

  Maximum Length: 1

  Default Value: false

  Indicates that the student will be dropped from the waitlist of other sections of a course after they have successfully enrolled in any sections for that course.
• ExpiredInvitationAction: string
  Title: Expired Invitation Action

  Read Only: true

  Maximum Length: 80

  The meaning of the expired invitation action code. A list of accepted values and meanings is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION.
• ExpiredInvitationActionCode: string
  Title: Expired Invitation Action Code

  Maximum Length: 30

  The expired invitation action code. A list of accepted values is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION.
• InvitationResponseHours: integer (int32)
  Title: Invitation Response Hours

  Default Value: 0

  The invitation response hours of the waitlist setting documenting how long a student has to respond to an open seat notification.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumControlType: string
  Title: Maximum Waitlist Control Type

  Read Only: true

  Maximum Length: 80

  The maximum waitlist control type. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE.
• MaximumControlTypeCode: string
  Title: Maximum Waitlist Control Type Code

  Maximum Length: 30

  The maximum waitlist control type code. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE.
• MaximumControlUnits: integer (int32)
  Title: Maximum Waitlist Control Units

  Default Value: 0

  The maximum number of control units that limits a student's ability to waitlist after this number is reached.
• OwningEntityCode: string
  Title: Owning Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the associated entity.
• OwningEntityId: integer (int64)
  Title: Owning Entity ID

  The unique identifier of the owning entity.
• OwningEntityName: string
  Title: Owning Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• OwningEntitySubTypeCode: string
  Title: Owning Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• OwningEntitySubTypeMeaning: string
  Title: Owning Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• OwningEntityTypeCode: string
  Title: Owning Entity Type Code

  Maximum Length: 30

  The entity type code of the owning entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• OwningEntityTypeMeaning: string
  Title: Owning Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• WaitlistCode: string
  Title: Waitlisting Code

  Read Only: true

  Maximum Length: 150

  The alternate unique identifier for waitlist settings.
• WaitlistingEnabledFlag: boolean
  Title: Waitlisting Enabled

  Maximum Length: 1

  Default Value: false

  Indicates that the waitlist setting is enabled.
• WaitlistSettingsId: integer (int64)
  Title: Waitlist Settings ID

  Read Only: true

  The unique identifier for the waitlist settings.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "assignments":{
            "title":"Waitlist Settings Assignments",
            "type":"array",
            "description":"The assignments resource is used to list the academic entities assigned to the waitlist settings.",
            "items":{
                "$ref":"#/components/schemas/waitlistSettings-assignments-item-response"
            }
        },
        "OwningEntityName":{
            "title":"Owning Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningEntityCode":{
            "title":"Owning Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WaitlistingEnabledFlag":{
            "title":"Waitlisting Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the waitlist setting is enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MaximumControlType":{
            "title":"Maximum Waitlist Control Type",
            "maxLength":"80",
            "type":"string",
            "description":"The maximum waitlist control type. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiredInvitationAction":{
            "title":"Expired Invitation Action",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the expired invitation action code. A list of accepted values and meanings is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningEntitySubTypeMeaning":{
            "title":"Owning Entity Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvitationResponseHours":{
            "title":"Invitation Response Hours",
            "type":"integer",
            "description":"The invitation response hours of the waitlist setting documenting how long a student has to respond to an open seat notification.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DropWLSectionsAfterEnrollFlag":{
            "title":"Drop Waitlisted Sections After Enrollment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the student will be dropped from the waitlist of other sections of a course after they have successfully enrolled in any sections for that course.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ExpiredInvitationActionCode":{
            "title":"Expired Invitation Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"The expired invitation action code. A list of accepted values is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwningEntityTypeCode":{
            "title":"Owning Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the owning entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwningEntityTypeMeaning":{
            "title":"Owning Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WaitlistSettingsId":{
            "title":"Waitlist Settings ID",
            "type":"integer",
            "description":"The unique identifier for the waitlist settings.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WaitlistCode":{
            "title":"Waitlisting Code",
            "maxLength":"150",
            "type":"string",
            "description":"The alternate unique identifier for waitlist settings.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumControlTypeCode":{
            "title":"Maximum Waitlist Control Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The maximum waitlist control type code. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwningEntityId":{
            "title":"Owning Entity ID",
            "type":"integer",
            "description":"The unique identifier of the owning entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwningEntitySubTypeCode":{
            "title":"Owning Entity Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumControlUnits":{
            "title":"Maximum Waitlist Control Units",
            "type":"integer",
            "description":"The maximum number of control units that limits a student's ability to waitlist after this number is reached.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultWaitlistCapacity":{
            "title":"Default Waitlist Capacity",
            "type":"integer",
            "description":"The default capacity of the waitlist.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Waitlist Settings Assignments

Type: array

Title: Waitlist Settings Assignments

The assignments resource is used to list the academic entities assigned to the waitlist settings.

Show Source

• Array of: object waitlistSettings-assignments-item-response

{
    "title":"Waitlist Settings Assignments",
    "type":"array",
    "description":"The assignments resource is used to list the academic entities assigned to the waitlist settings.",
    "items":{
        "$ref":"#/components/schemas/waitlistSettings-assignments-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 : waitlistSettings-assignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntitySubTypeCode: string
  Title: Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• AssignedEntitySubTypeMeaning: string
  Title: Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• AssignmentMethod: string
  Title: Assignment Method

  Read Only: true

  Maximum Length: 80

  The assignment method type meaning used to indicate how waitlist settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentMethodCode: string
  Title: Assignment Method Code

  Maximum Length: 30

  Default Value: ORA_DIRECT

  The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the associated entity.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelatedEntityCode: string
  Title: Related Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the associated entity.
• RelatedEntityId: integer (int64)
  Title: Related Entity ID

  The unique identifier of the related entity.
• RelatedEntityName: string
  Title: Related Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• RelatedEntitySubTypeCode: string
  Title: Related Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• RelatedEntitySubTypeMeaning: string
  Title: Related Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• RelatedEntityTypeCode: string
  Title: Related Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• RelatedEntityTypeMeaning: string
  Title: Related Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeMeaning":{
            "title":"Related Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeCode":{
            "title":"Entity Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedEntityId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentMethodCode":{
            "title":"Assignment Method Code",
            "maxLength":"30",
            "type":"string",
            "description":"The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedEntitySubTypeCode":{
            "title":"Related Entity Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMethod":{
            "title":"Assignment Method",
            "maxLength":"80",
            "type":"string",
            "description":"The assignment method type meaning used to indicate how waitlist settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeMeaning":{
            "title":"Entity Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelatedEntitySubTypeMeaning":{
            "title":"Related Entity Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedEntityCode":{
            "title":"Related Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityName":{
            "title":"Related Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the 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."
        }
    }
}

Links

ExipredInvitationActionCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_EXP_WL_INV_ACTION

The following properties are defined on the LOV link relation:

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

MaximumControlTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_MAX_WL_CONTROL_TYPE

The following properties are defined on the LOV link relation:

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

OwningEntityTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_ASSOCIATED_OBJECT_TYPE

The following properties are defined on the LOV link relation:

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

assignments

Operation: /fscmRestApi/resources/11.13.18.05/waitlistSettings/{WaitlistSettingsId}/child/assignments

Parameters:

• WaitlistSettingsId: $request.path.WaitlistSettingsId

The assignments resource is used to list the academic entities assigned to the waitlist settings.

Back to Top