Jump to

• Request
• Response

Create all drop schemes

post

/fscmRestApi/resources/11.13.18.05/dropSchemes

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 Drop Scheme Settings Assignments
  Title: Drop Scheme Settings Assignments

  Drop scheme assignments represent the academic entities assigned to the drop scheme settings.
• DropSchemeCode(required): string
  Title: Code

  Maximum Length: 30

  The alternate unique identifier for drop scheme settings.
• DropSchemeDescription: string
  Title: Description

  Maximum Length: 255

  The long description for the drop scheme setting.
• DropSchemeName(required): string
  Title: Name

  Maximum Length: 50

  The unique name for the drop scheme setting.
• dropSchemeTypes: array Drop Scheme Types
  Title: Drop Scheme Types

  The drop scheme types resource maps predefined drop types to predefined enrollment statuses.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_HER_INACTIVE

  The drop scheme status code. A list of accepted values is defined in the lookup type ORA_HER_DROPSCHEME_STATUS.

{
    "required":[
        "DropSchemeCode",
        "DropSchemeName"
    ],
    "type":"object",
    "properties":{
        "assignments":{
            "title":"Drop Scheme Settings Assignments",
            "type":"array",
            "description":"Drop scheme assignments represent the academic entities assigned to the drop scheme settings.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-assignments-item-post-request"
            }
        },
        "DropSchemeCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier for drop scheme settings.",
            "nullable":false
        },
        "DropSchemeDescription":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The long description for the drop scheme setting.",
            "nullable":true
        },
        "DropSchemeName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the drop scheme setting.",
            "nullable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The drop scheme status code. A list of accepted values is defined in the lookup type ORA_HER_DROPSCHEME_STATUS.",
            "nullable":false,
            "default":"ORA_HER_INACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "dropSchemeTypes":{
            "title":"Drop Scheme Types",
            "type":"array",
            "description":"The drop scheme types resource maps predefined drop types to predefined enrollment statuses.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-item-post-request"
            }
        }
    }
}

Nested Schema : Drop Scheme Settings Assignments

Type: array

Title: Drop Scheme Settings Assignments

Drop scheme assignments represent the academic entities assigned to the drop scheme settings.

Show Source

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

{
    "title":"Drop Scheme Settings Assignments",
    "type":"array",
    "description":"Drop scheme assignments represent the academic entities assigned to the drop scheme settings.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-assignments-item-post-request"
    }
}

Nested Schema : Drop Scheme Types

Type: array

Title: Drop Scheme Types

The drop scheme types resource maps predefined drop types to predefined enrollment statuses.

Show Source

• Array of: object schema

{
    "title":"Drop Scheme Types",
    "type":"array",
    "description":"The drop scheme types resource maps predefined drop types to predefined enrollment statuses.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-item-post-request"
    }
}

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

Type: object

Show Source

• AssignedEntityId(required): integer (int64)
  Title: Entity ID

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

  Maximum Length: 30

  The type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedSettingsObjectId: integer (int64)
  Title: Settings Object ID

  The unique identifier of the associated setting.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentMethodTypeCode: 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.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• associatedAssignments: array Drop Scheme Settings Associated Assignments
  Title: Drop Scheme Settings Associated Assignments

  The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.
• 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 related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.

{
    "required":[
        "AssignedEntityId",
        "AssignedEntityTypeCode"
    ],
    "type":"object",
    "properties":{
        "AssignmentMethodTypeCode":{
            "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",
                "PAYLOADHINT":"Show"
            }
        },
        "AssignedSettingsObjectId":{
            "title":"Settings Object ID",
            "type":"integer",
            "description":"The unique identifier of the associated setting.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false
        },
        "RelatedEntityTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "RelatedEntityId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The 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"
            }
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false
        },
        "associatedAssignments":{
            "title":"Drop Scheme Settings Associated Assignments",
            "type":"array",
            "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-item-post-request"
            }
        }
    }
}

Nested Schema : Drop Scheme Settings Associated Assignments

Type: array

Title: Drop Scheme Settings Associated Assignments

The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.

Show Source

• Array of: object schema

{
    "title":"Drop Scheme Settings Associated Assignments",
    "type":"array",
    "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AssociatedObjectId: integer (int64)
  Title: Associated Object ID

  The unique identifier of the object. It can be an academic level ID.
• AssociatedObjectTypeCode: string
  Title: Associated Object Type Code

  Maximum Length: 30

  Default Value: ORA_HER_ACADEMIC_LEVEL

  The type code of the associated object. A list of accepted values is defined in the lookup type ORA_HEY_SUB_OBJECT_TYPE.

{
    "type":"object",
    "properties":{
        "AssociatedObjectTypeCode":{
            "title":"Associated Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the associated object. A list of accepted values is defined in the lookup type ORA_HEY_SUB_OBJECT_TYPE.",
            "nullable":false,
            "default":"ORA_HER_ACADEMIC_LEVEL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssociatedObjectId":{
            "title":"Associated Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. It can be an academic level ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• DropPeriodAttributeCode(required): string
  Title: Period Attribute Code

  Maximum Length: 30

  The unique code of the drop type attribute.
• DropPeriodAttributeId(required): integer (int64)
  Title: Drop Attribute ID

  The unique identifier for the drop attribute that's associated with the drop scheme.
• dropTypeResults: array Drop Scheme Type Results
  Title: Drop Scheme Type Results

  The drop scheme type results resource maps penalty drop type to penalty result.
• DropTypeSequenceNumber(required): integer (int32)
  Title: Drop Type Sequence

  The sequence of the drop scheme type record.
• EnrollmentStatusCode(required): string
  Title: Enrollment Status

  Maximum Length: 30

  The enrollment status for the drop scheme type record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.

{
    "required":[
        "DropPeriodAttributeCode",
        "DropPeriodAttributeId",
        "DropTypeSequenceNumber",
        "EnrollmentStatusCode"
    ],
    "type":"object",
    "properties":{
        "dropTypeResults":{
            "title":"Drop Scheme Type Results",
            "type":"array",
            "description":"The drop scheme type results resource maps penalty drop type to penalty result.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-dropTypeResults-item-post-request"
            }
        },
        "DropPeriodAttributeCode":{
            "title":"Period Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code of the drop type attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnrollmentStatusCode":{
            "title":"Enrollment Status",
            "maxLength":"30",
            "type":"string",
            "description":"The enrollment status for the drop scheme type record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DropTypeSequenceNumber":{
            "title":"Drop Type Sequence",
            "type":"integer",
            "description":"The sequence of the drop scheme type record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "DropPeriodAttributeId":{
            "title":"Drop Attribute ID",
            "type":"integer",
            "description":"The unique identifier for the drop attribute that's associated with the drop scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Drop Scheme Type Results

Type: array

Title: Drop Scheme Type Results

The drop scheme type results resource maps penalty drop type to penalty result.

Show Source

• Array of: object dropSchemes-dropSchemeTypes-dropTypeResults-item-post-request

{
    "title":"Drop Scheme Type Results",
    "type":"array",
    "description":"The drop scheme type results resource maps penalty drop type to penalty result.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-dropTypeResults-item-post-request"
    }
}

Nested Schema : dropSchemes-dropSchemeTypes-dropTypeResults-item-post-request

Type: object

Show Source

• DefaultFlag: boolean
  Title: Default

  Maximum Length: 1

  Indicates whether the default value is true or false for the drop type result.
• ResultNumericValue: number
  Title: Result Numeric Value

  The numeric value associated with the drop type result.
• ResultSequenceNumber: integer (int32)
  Title: Result Sequence

  The sequence number associated with the drop type result.
• ResultSetCode: string
  Title: Code

  Maximum Length: 30

  The code of a result set that's associated with the drop type.
• ResultSetId: integer (int64)
  Title: Result Set

  The unique identifier for result set that's associated with the drop type.
• ResultTextValue: string
  Title: Result

  Maximum Length: 30

  The text value associated with the drop type result.

{
    "type":"object",
    "properties":{
        "ResultSetCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of a result set that's associated with the drop type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResultNumericValue":{
            "title":"Result Numeric Value",
            "type":"number",
            "description":"The numeric value associated with the drop type result.",
            "nullable":true
        },
        "ResultSequenceNumber":{
            "title":"Result Sequence",
            "type":"integer",
            "description":"The sequence number associated with the drop type result.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ResultSetId":{
            "title":"Result Set",
            "type":"integer",
            "description":"The unique identifier for result set that's associated with the drop type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DefaultFlag":{
            "title":"Default",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the default value is true or false for the drop type result.",
            "nullable":false
        },
        "ResultTextValue":{
            "title":"Result",
            "maxLength":"30",
            "type":"string",
            "description":"The text value associated with the drop type result.",
            "nullable":true,
            "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:
  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 : dropSchemes-item-response

Type: object

Show Source

• assignments: array Drop Scheme Settings Assignments
  Title: Drop Scheme Settings Assignments

  Drop scheme assignments represent the academic entities assigned to the drop scheme 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.
• DropSchemeCode: string
  Title: Code

  Maximum Length: 30

  The alternate unique identifier for drop scheme settings.
• DropSchemeDescription: string
  Title: Description

  Maximum Length: 255

  The long description for the drop scheme setting.
• DropSchemeId: integer (int64)
  Title: Drop Scheme ID

  Read Only: true

  The unique identifier for the drop scheme setting.
• DropSchemeName: string
  Title: Name

  Maximum Length: 50

  The unique name for the drop scheme setting.
• dropSchemeTypes: array Drop Scheme Types
  Title: Drop Scheme Types

  The drop scheme types resource maps predefined drop types to predefined enrollment statuses.
• LastUpdateDate: string (date-time)
  Title: Last Update 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.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_HER_INACTIVE

  The drop scheme status code. A list of accepted values is defined in the lookup type ORA_HER_DROPSCHEME_STATUS.
• StatusMeaning: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the drop scheme status code. A list of accepted values is defined in the lookup type ORA_HER_DROPSCHEME_STATUS.

{
    "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":"Drop Scheme Settings Assignments",
            "type":"array",
            "description":"Drop scheme assignments represent the academic entities assigned to the drop scheme settings.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-assignments-item-response"
            }
        },
        "DropSchemeDescription":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The long description for the drop scheme setting.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The drop scheme status code. A list of accepted values is defined in the lookup type ORA_HER_DROPSCHEME_STATUS.",
            "nullable":false,
            "default":"ORA_HER_INACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "dropSchemeTypes":{
            "title":"Drop Scheme Types",
            "type":"array",
            "description":"The drop scheme types resource maps predefined drop types to predefined enrollment statuses.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-item-response"
            }
        },
        "StatusMeaning":{
            "title":"Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the drop scheme status code. A list of accepted values is defined in the lookup type ORA_HER_DROPSCHEME_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DropSchemeId":{
            "title":"Drop Scheme ID",
            "type":"integer",
            "description":"The unique identifier for the drop scheme setting.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DropSchemeCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier for drop scheme settings.",
            "nullable":false,
            "x-queryable":true
        },
        "DropSchemeName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the drop scheme setting.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Drop Scheme Settings Assignments

Type: array

Title: Drop Scheme Settings Assignments

Drop scheme assignments represent the academic entities assigned to the drop scheme settings.

Show Source

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

{
    "title":"Drop Scheme Settings Assignments",
    "type":"array",
    "description":"Drop scheme assignments represent the academic entities assigned to the drop scheme settings.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-assignments-item-response"
    }
}

Nested Schema : Drop Scheme Types

Type: array

Title: Drop Scheme Types

The drop scheme types resource maps predefined drop types to predefined enrollment statuses.

Show Source

• Array of: object dropSchemes-dropSchemeTypes-item-response

{
    "title":"Drop Scheme Types",
    "type":"array",
    "description":"The drop scheme types resource maps predefined drop types to predefined enrollment statuses.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-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 : dropSchemes-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.
• AssignedEntityStatusCode: string
  Title: Entity Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the entity. This controls the availability of the entity for assignments to settings.
• AssignedEntityStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The status of the 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 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.
• AssignedSettingsObjectId: integer (int64)
  Title: Settings Object ID

  The unique identifier of the associated setting.
• AssignedSettingsTypeCode: string
  Title: Settings Type Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_HER_DROP_SCHEME

  The type code of the associated setting.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentMethodMeaning: string
  Title: Assignment Method

  Read Only: true

  Maximum Length: 80

  The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentMethodTypeCode: 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.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• associatedAssignments: array Drop Scheme Settings Associated Assignments
  Title: Drop Scheme Settings Associated Assignments

  The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme 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.
• LastUpdateDate: string (date-time)
  Title: Last Update 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 related 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 related entity.
• RelatedEntityTypeCode: string
  Title: Related Entity Type Code

  Maximum Length: 30

  The entity type code of the related 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 related entity.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "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"
            },
            "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 related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "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",
                "PAYLOADHINT":"Show"
            },
            "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
        },
        "AssignmentMethodMeaning":{
            "title":"Assignment Method",
            "maxLength":"80",
            "type":"string",
            "description":"The assignment method type meaning used to indicate 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,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityStatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the entity.",
            "nullable":true,
            "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
        },
        "AssignedSettingsObjectId":{
            "title":"Settings Object ID",
            "type":"integer",
            "description":"The unique identifier of the associated setting.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "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 related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "RelatedEntityTypeMeaning":{
            "title":"Related Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the related entity.",
            "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
        },
        "AssignmentMethodTypeCode":{
            "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",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityStatusCode":{
            "title":"Entity Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the entity. This controls the availability of the entity for assignments to settings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The 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
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedSettingsTypeCode":{
            "title":"Settings Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the associated setting.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HER_DROP_SCHEME",
            "x-queryable":true
        },
        "RelatedEntityName":{
            "title":"Related Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "associatedAssignments":{
            "title":"Drop Scheme Settings Associated Assignments",
            "type":"array",
            "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-item-response"
            }
        }
    }
}

Nested Schema : Drop Scheme Settings Associated Assignments

Type: array

Title: Drop Scheme Settings Associated Assignments

The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.

Show Source

• Array of: object dropSchemes-assignments-associatedAssignments-item-response

{
    "title":"Drop Scheme Settings Associated Assignments",
    "type":"array",
    "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-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 : dropSchemes-assignments-associatedAssignments-item-response

Type: object

Show Source

• AssociatedAssignmentId: integer (int64)
  Title: Associated Assignment ID

  Read Only: true

  The unique identifier for the settings associated assignment record.
• AssociatedObjectCode: string
  Title: Academic Level Code

  Read Only: true

  Maximum Length: 100

  The unique code of the object. It can be an academic level code.
• AssociatedObjectId: integer (int64)
  Title: Associated Object ID

  The unique identifier of the object. It can be an academic level ID.
• AssociatedObjectName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of the object. It can be an academic level name.
• AssociatedObjectTypeCode: string
  Title: Associated Object Type Code

  Maximum Length: 30

  Default Value: ORA_HER_ACADEMIC_LEVEL

  The type code of the associated object. A list of accepted values is defined in the lookup type ORA_HEY_SUB_OBJECT_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssociatedObjectName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the object. It can be an academic level name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedObjectId":{
            "title":"Associated Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. It can be an academic level ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociatedAssignmentId":{
            "title":"Associated Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the settings associated assignment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssociatedObjectTypeCode":{
            "title":"Associated Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the associated object. A list of accepted values is defined in the lookup type ORA_HEY_SUB_OBJECT_TYPE.",
            "nullable":false,
            "default":"ORA_HER_ACADEMIC_LEVEL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociatedObjectCode":{
            "title":"Academic Level Code",
            "maxLength":"100",
            "type":"string",
            "description":"The unique code of the object. It can be an academic level code.",
            "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 : dropSchemes-dropSchemeTypes-item-response

Type: object

Show Source

• DropPeriodAttributeCode: string
  Title: Period Attribute Code

  Maximum Length: 30

  The unique code of the drop type attribute.
• DropPeriodAttributeId: integer (int64)
  Title: Drop Attribute ID

  The unique identifier for the drop attribute that's associated with the drop scheme.
• DropPeriodAttributeName: string
  Title: Period Attribute Name

  Read Only: true

  Maximum Length: 50

  The name of the drop type attribute.
• DropPeriodAttributeTypeCode: string
  Title: Drop Attribute Type

  Read Only: true

  Maximum Length: 30

  The type of the drop type attribute.
• DropPeriodAttributeTypeMeaning: string
  Title: Drop Attribute Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the drop attribute type.
• DropSchemeTypeId: integer (int64)
  Title: Drop Scheme Type ID

  Read Only: true

  The unique identifier for the drop scheme type record.
• dropTypeResults: array Drop Scheme Type Results
  Title: Drop Scheme Type Results

  The drop scheme type results resource maps penalty drop type to penalty result.
• DropTypeSequenceNumber: integer (int32)
  Title: Drop Type Sequence

  The sequence of the drop scheme type record.
• EnrollmentStatusCode: string
  Title: Enrollment Status

  Maximum Length: 30

  The enrollment status for the drop scheme type record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
• EnrollmentStatusMeaning: string
  Title: Enrollment Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the enrollment status. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "dropTypeResults":{
            "title":"Drop Scheme Type Results",
            "type":"array",
            "description":"The drop scheme type results resource maps penalty drop type to penalty result.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-dropTypeResults-item-response"
            }
        },
        "DropSchemeTypeId":{
            "title":"Drop Scheme Type ID",
            "type":"integer",
            "description":"The unique identifier for the drop scheme type record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DropPeriodAttributeTypeMeaning":{
            "title":"Drop Attribute Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the drop attribute type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DropPeriodAttributeCode":{
            "title":"Period Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code of the drop type attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DropPeriodAttributeName":{
            "title":"Period Attribute Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the drop type attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentStatusCode":{
            "title":"Enrollment Status",
            "maxLength":"30",
            "type":"string",
            "description":"The enrollment status for the drop scheme type record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DropTypeSequenceNumber":{
            "title":"Drop Type Sequence",
            "type":"integer",
            "description":"The sequence of the drop scheme type record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DropPeriodAttributeTypeCode":{
            "title":"Drop Attribute Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the drop type attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnrollmentStatusMeaning":{
            "title":"Enrollment Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the enrollment status. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DropPeriodAttributeId":{
            "title":"Drop Attribute ID",
            "type":"integer",
            "description":"The unique identifier for the drop attribute that's associated with the drop scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Drop Scheme Type Results

Type: array

Title: Drop Scheme Type Results

The drop scheme type results resource maps penalty drop type to penalty result.

Show Source

• Array of: object dropSchemes-dropSchemeTypes-dropTypeResults-item-response

{
    "title":"Drop Scheme Type Results",
    "type":"array",
    "description":"The drop scheme type results resource maps penalty drop type to penalty result.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-dropSchemeTypes-dropTypeResults-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 : dropSchemes-dropSchemeTypes-dropTypeResults-item-response

Type: object

Show Source

• DefaultFlag: boolean
  Title: Default

  Maximum Length: 1

  Indicates whether the default value is true or false for the drop type result.
• DropPeriodAttributeName: string
  Title: Period Attribute Name

  Read Only: true

  Maximum Length: 50

  The name of the drop attribute for which this result is defined.
• DropTypeResultId: integer (int64)
  Title: Drop Type Result ID

  Read Only: true

  The unique identifier for the drop type result record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultGradePoints: number
  Title: Result Grade Points

  Read Only: true

  The grade points associated with the drop type result.
• ResultNumericValue: number
  Title: Result Numeric Value

  The numeric value associated with the drop type result.
• ResultOutcomeCode: string
  Title: Result Outcome Code

  Read Only: true

  Maximum Length: 230

  The outcome code associated with the drop type result.
• ResultSequenceNumber: integer (int32)
  Title: Result Sequence

  The sequence number associated with the drop type result.
• ResultSetCode: string
  Title: Code

  Maximum Length: 30

  The code of a result set that's associated with the drop type.
• ResultSetId: integer (int64)
  Title: Result Set

  The unique identifier for result set that's associated with the drop type.
• ResultSetName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of a result set that's associated with the drop type.
• ResultTextValue: string
  Title: Result

  Maximum Length: 30

  The text value associated with the drop type result.

{
    "type":"object",
    "properties":{
        "ResultSetCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of a result set that's associated with the drop type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResultNumericValue":{
            "title":"Result Numeric Value",
            "type":"number",
            "description":"The numeric value associated with the drop type result.",
            "nullable":true,
            "x-queryable":true
        },
        "DropPeriodAttributeName":{
            "title":"Period Attribute Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the drop attribute for which this result is defined.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultOutcomeCode":{
            "title":"Result Outcome Code",
            "maxLength":"230",
            "type":"string",
            "description":"The outcome code associated with the drop type result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSequenceNumber":{
            "title":"Result Sequence",
            "type":"integer",
            "description":"The sequence number associated with the drop type result.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set",
            "type":"integer",
            "description":"The unique identifier for result set that's associated with the drop type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a result set that's associated with the drop type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultGradePoints":{
            "title":"Result Grade Points",
            "type":"number",
            "description":"The grade points associated with the drop type result.",
            "nullable":true,
            "readOnly":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"
            }
        },
        "DefaultFlag":{
            "title":"Default",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the default value is true or false for the drop type result.",
            "nullable":false,
            "x-queryable":true
        },
        "DropTypeResultId":{
            "title":"Drop Type Result ID",
            "type":"integer",
            "description":"The unique identifier for the drop type result record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResultTextValue":{
            "title":"Result",
            "maxLength":"30",
            "type":"string",
            "description":"The text value associated with the drop type result.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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

StatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_DROPSCHEME_STATUS%2CLookupCode%3D{StatusCode}

The following properties are defined on the LOV link relation:

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

assignments

Operation: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments

Parameters:

• DropSchemeId: $request.path.DropSchemeId

Drop scheme assignments represent the academic entities assigned to the drop scheme settings.

dropSchemeTypes

Operation: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/dropSchemeTypes

Parameters:

• DropSchemeId: $request.path.DropSchemeId

The drop scheme types resource maps predefined drop types to predefined enrollment statuses.

Back to Top