Jump to

• Request
• Response

Update an academic level

patch

/fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}

Request

Path Parameters

• AcademicLevelId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assignments: array Assignments
  Title: Assignments

  The assignments resource provides a list of academic entities which have been assigned.
• Description: string
  Title: Academic Level Description

  Maximum Length: 1000

  The description of the academic level.
• enrollmentInclusions: array Enrollment Inclusions
  Title: Enrollment Inclusions

  The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.
• ForCreditFlag: boolean
  Title: For Credit

  Maximum Length: 1

  Default Value: true

  Indicates the academic level is for credit.
• institutions: array Institutions
  Title: Institutions

  The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.
• LevelName: string
  Title: Academic Level Name

  Maximum Length: 100

  The name of the academic level.
• LevelStatusCode: string
  Title: Level Status Code

  Maximum Length: 30

  Default Value: ORA_INACTIVE

  The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS.
• MinimumFullTimeUnits: number
  Title: Minimum Full Time Units

  Default Value: 0

  The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.
• PrimacyNumber: integer (int32)
  Title: Primacy Number

  The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.
• RepeatFailureHandlerCode: string
  Title: Enrollment Repeat Option

  Maximum Length: 30

  Default Value: ORA_NONE

  Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
• RequiresStudentProgramFlag: boolean
  Title: Requires student program

  Maximum Length: 1

  Indicates that a student can enroll only if the student is assigned to a program.
• TypeOfCreditCode: string
  Title: Type of Credit Code

  Maximum Length: 30

  Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Academic Level Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the academic level.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ForCreditFlag":{
            "title":"For Credit",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the academic level is for credit.",
            "nullable":false,
            "default":true
        },
        "LevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "LevelStatusCode":{
            "title":"Level Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS.",
            "nullable":false,
            "default":"ORA_INACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinimumFullTimeUnits":{
            "title":"Minimum Full Time Units",
            "type":"number",
            "description":"The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            }
        },
        "PrimacyNumber":{
            "title":"Primacy Number",
            "type":"integer",
            "description":"The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3,
                "PAYLOADHINT":"Show"
            }
        },
        "RepeatFailureHandlerCode":{
            "title":"Enrollment Repeat Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequiresStudentProgramFlag":{
            "title":"Requires student program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can enroll only if the student is assigned to a program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "TypeOfCreditCode":{
            "title":"Type of Credit Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "assignments":{
            "title":"Assignments",
            "type":"array",
            "description":"The assignments resource provides a list of academic entities which have been assigned.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-assignments-item-patch-request"
            }
        },
        "enrollmentInclusions":{
            "title":"Enrollment Inclusions",
            "type":"array",
            "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-patch-request"
            }
        },
        "institutions":{
            "title":"Institutions",
            "type":"array",
            "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-institutions-item-patch-request"
            }
        }
    }
}

Nested Schema : Assignments

Type: array

Title: Assignments

The assignments resource provides a list of academic entities which have been assigned.

Show Source

• Array of: object schema

{
    "title":"Assignments",
    "type":"array",
    "description":"The assignments resource provides a list of academic entities which have been assigned.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-assignments-item-patch-request"
    }
}

Nested Schema : Enrollment Inclusions

Type: array

Title: Enrollment Inclusions

The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.

Show Source

• Array of: object schema

{
    "title":"Enrollment Inclusions",
    "type":"array",
    "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-patch-request"
    }
}

Nested Schema : Institutions

Type: array

Title: Institutions

The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.

Show Source

• Array of: object academicLevels-institutions-item-patch-request

{
    "title":"Institutions",
    "type":"array",
    "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-institutions-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.

{
    "type":"object",
    "properties":{
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• IncludeAcademicLevelId: integer (int64)
  Title: Included Academic Level ID

  The unique identifier for the academic level that's included for enrollment.

{
    "type":"object",
    "properties":{
        "IncludeAcademicLevelId":{
            "title":"Included Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for the academic level that's included for enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : academicLevels-institutions-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : academicLevels-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for an academic level.
• ActiveFlag: boolean
  Title: Academic Level Active

  Read Only: true

  Maximum Length: 1

  Indicates the active status of the academic level.
• AllInstitutionsFlag: boolean
  Title: Available for all institutions

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates the academic level is available for all academic institutions.
• assignments: array Assignments
  Title: Assignments

  The assignments resource provides a list of academic entities which have been assigned.
• 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: Academic Level Description

  Maximum Length: 1000

  The description of the academic level.
• enrollmentInclusions: array Enrollment Inclusions
  Title: Enrollment Inclusions

  The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.
• ForCreditFlag: boolean
  Title: For Credit

  Maximum Length: 1

  Default Value: true

  Indicates the academic level is for credit.
• institutions: array Institutions
  Title: Institutions

  The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.
• 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.
• LevelCode: string
  Title: Academic Level Code

  Maximum Length: 100

  The code of the academic level.
• LevelName: string
  Title: Academic Level Name

  Maximum Length: 100

  The name of the academic level.
• LevelStatus: string
  Title: Level Status

  Read Only: true

  Maximum Length: 80

  The status meaning of the academic level.
• LevelStatusCode: string
  Title: Level Status Code

  Maximum Length: 30

  Default Value: ORA_INACTIVE

  The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumFullTimeUnits: number
  Title: Minimum Full Time Units

  Default Value: 0

  The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.
• PrimacyNumber: integer (int32)
  Title: Primacy Number

  The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.
• RepeatFailureHandlerCode: string
  Title: Enrollment Repeat Option

  Maximum Length: 30

  Default Value: ORA_NONE

  Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
• RepeatFailureHandlerMeaning: string
  Title: Repeat Handler Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of repeat failure handler code. Valid values include None, Error or Warning. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
• RequiresStudentProgramFlag: boolean
  Title: Requires student program

  Maximum Length: 1

  Indicates that a student can enroll only if the student is assigned to a program.
• TypeOfCredit: string
  Title: Type of Credit

  Read Only: true

  Maximum Length: 80

  The meaning of the type of credit. Valid values include Continuing education units, Credit hours and No Credit Type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• TypeOfCreditCode: string
  Title: Type of Credit Code

  Maximum Length: 30

  Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.

{
    "type":"object",
    "properties":{
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Academic Level Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the active status of the academic level.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AllInstitutionsFlag":{
            "title":"Available for all institutions",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the academic level is available for all academic institutions.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Academic Level Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the academic level.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ForCreditFlag":{
            "title":"For Credit",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the academic level is for credit.",
            "nullable":false,
            "default":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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelCode":{
            "title":"Academic Level Code",
            "maxLength":100,
            "type":"string",
            "description":"The code of the academic level.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LevelStatus":{
            "title":"Level Status",
            "maxLength":80,
            "type":"string",
            "description":"The status meaning of the academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelStatusCode":{
            "title":"Level Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS.",
            "nullable":false,
            "default":"ORA_INACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumFullTimeUnits":{
            "title":"Minimum Full Time Units",
            "type":"number",
            "description":"The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "PrimacyNumber":{
            "title":"Primacy Number",
            "type":"integer",
            "description":"The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RepeatFailureHandlerCode":{
            "title":"Enrollment Repeat Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RepeatFailureHandlerMeaning":{
            "title":"Repeat Handler Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of repeat failure handler code. Valid values include None, Error or Warning. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiresStudentProgramFlag":{
            "title":"Requires student program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can enroll only if the student is assigned to a program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TypeOfCredit":{
            "title":"Type of Credit",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit. Valid values include Continuing education units, Credit hours and No Credit Type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeOfCreditCode":{
            "title":"Type of Credit Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignments":{
            "title":"Assignments",
            "type":"array",
            "description":"The assignments resource provides a list of academic entities which have been assigned.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-assignments-item-response"
            }
        },
        "enrollmentInclusions":{
            "title":"Enrollment Inclusions",
            "type":"array",
            "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-response"
            }
        },
        "institutions":{
            "title":"Institutions",
            "type":"array",
            "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-institutions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Assignments

Type: array

Title: Assignments

The assignments resource provides a list of academic entities which have been assigned.

Show Source

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

{
    "title":"Assignments",
    "type":"array",
    "description":"The assignments resource provides a list of academic entities which have been assigned.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-assignments-item-response"
    }
}

Nested Schema : Enrollment Inclusions

Type: array

Title: Enrollment Inclusions

The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.

Show Source

• Array of: object academicLevels-enrollmentInclusions-item-response

{
    "title":"Enrollment Inclusions",
    "type":"array",
    "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-response"
    }
}

Nested Schema : Institutions

Type: array

Title: Institutions

The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.

Show Source

• Array of: object academicLevels-institutions-item-response

{
    "title":"Institutions",
    "type":"array",
    "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-institutions-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 : academicLevels-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: Assigned 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: Assigned Entity 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

  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.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

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

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier 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":{
                "controlType":"choice",
                "precision":18
            },
            "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
        },
        "AssignedEntityStatusCode":{
            "title":"Assigned 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
        },
        "AssignedEntityStatusMeaning":{
            "title":"Assigned Entity Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the 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
        },
        "AssignedEntitySubTypeMeaning":{
            "title":"Entity Subtype",
            "maxLength":80,
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : academicLevels-enrollmentInclusions-item-response

Type: object

Show Source

• EnrollmentInclusionId: integer (int64)
  Title: Academic Level Enrollment Inclusion ID

  Read Only: true

  The unique identifier for an enrollment inclusion. Enrollment inclusions at the course academic level indicate the student academic levels that are eligible to enroll in a course. Inclusions apply only when enrollment is restricted to students who are assigned to a program.
• IncludeAcademicLevelId: integer (int64)
  Title: Included Academic Level ID

  The unique identifier for the academic level that's included for enrollment.
• IncludeLevelCode: string
  Title: Included Level Code

  Read Only: true

  Maximum Length: 100

  The code of the academic level.
• IncludeLevelName: string
  Title: Included Level Name

  Read Only: true

  Maximum Length: 100

  The name of the academic level.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EnrollmentInclusionId":{
            "title":"Academic Level Enrollment Inclusion ID",
            "type":"integer",
            "description":"The unique identifier for an enrollment inclusion. Enrollment inclusions at the course academic level indicate the student academic levels that are eligible to enroll in a course. Inclusions apply only when enrollment is restricted to students who are assigned to a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "IncludeAcademicLevelId":{
            "title":"Included Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for the academic level that's included for enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "IncludeLevelCode":{
            "title":"Included Level Code",
            "maxLength":100,
            "type":"string",
            "description":"The code of the academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeLevelName":{
            "title":"Included Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level.",
            "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"
            }
        }
    }
}

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 : academicLevels-institutions-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  Unique identifier for an academic level.
• AcademicLevelInstitutionId: integer (int64)
  Title: Academic Level Institution ID

  Read Only: true

  The unique identifier for the institution that's associated with an academic level.
• InstitutionId: integer (int64)
  Title: Institution ID

  Read Only: true

  The unique identifier of an academic institution.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"Unique identifier for an academic level.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelInstitutionId":{
            "title":"Academic Level Institution ID",
            "type":"integer",
            "description":"The unique identifier for the institution that's associated with an academic level.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier of an academic institution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

assignments

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/assignments

Parameters:

• AcademicLevelId: $request.path.AcademicLevelId

The assignments resource provides a list of academic entities which have been assigned.

enrollmentInclusions

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/enrollmentInclusions

Parameters:

• AcademicLevelId: $request.path.AcademicLevelId

The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.

institutions

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/institutions

Parameters:

• AcademicLevelId: $request.path.AcademicLevelId

The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.

levelStatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{LevelStatusCode}%2CLookupType%3DORA_HER_ACADEMIC_LEVEL_STATUS

The following properties are defined on the LOV link relation:

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

typeOfCreditCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{TypeOfCreditCode}%2CLookupType%3DORA_HER_CREDIT_TYPE_CODE

The following properties are defined on the LOV link relation:

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

Back to Top