Jump to

• Request
• Response

Update an academic plan template

patch

/fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}

Request

Path Parameters

• academicPlanTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Academic Plan Templates resource and used to uniquely identify an instance of Academic Plan Templates. The client should not generate the hash key value. Instead, the client should query on the Academic Plan Templates collection resource in order to navigate to a specific instance of Academic Plan Templates to get the hash key.

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AcademicGroupId: integer (int64)
  Title: Academic Group ID

  The unique identifier for an academic group value that's associated with an academic plan template.
• AcademicLoadCode: string
  Title: AcademicLoadCode

  Maximum Length: 30

  The code of academic load associated with the plan template such as full time or part time.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 2

  Indicates whether the academic plan template is active or inactive.
• BuildAcademicPlanFlag: boolean
  Indicates whether the build academic plan option for academic plan template is active or inactive.
• CreditTypeCode: string
  Title: Credit Type Code

  Maximum Length: 30

  The code of the credit type that's associated with an academic plan template.
• DeleteAcademicPlanFlag: boolean
  Indicates whether the delete academic plan option for academic plan template is active or inactive.
• EndDate: string (date)
  Title: End Date

  The end date of the academic plan template.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for an institution value that's associated with an academic plan template.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The name of an institution that's associated with an academic plan template.
• instructions: array Instructions
  Title: Instructions

  The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.
• LockPlanFlag: boolean
  Title: Lock Plan Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether the lock plan option for academic plan template is active or inactive.
• LongDescription: string
  Title: Long Description

  The description of the academic plan template.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Courses

  Default Value: 0

  The maximum number of courses required for the plan template.
• MaximumUnitsQuantity: integer (int32)
  Title: Maximum Units

  Default Value: 0

  The maximum units required for the plan template.
• MinimumCoursesQuantity: integer (int32)
  Title: Minimum Courses

  Default Value: 0

  The minimum number of courses required for the plan template.
• MinimumUnitsQuantity: integer (int32)
  Title: Minimum Units

  Default Value: 0

  The minimum units required for the plan template.
• owners: array Owners
  Title: Owners

  The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.
• periods: array Periods
  Title: Periods

  The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.
• PlanFormatId: integer (int64)
  Title: Plan Format ID

  The unique identifier for the associated plan format.
• PlanFormatName: string
  Title: Format Name

  Maximum Length: 50

  The name of a plan format that's associated with an academic plan template.
• StartDate: string (date)
  Title: Start Date

  The start date of the academic plan template.
• TemplateCode: string
  Title: Plan Template Code

  Maximum Length: 50

  The unique code to identify the plan template.
• TemplateLockFlag: boolean
  Title: Enable Template Lock

  Maximum Length: 1

  Indicates whether the template will allow locking of template periods and elements.
• TemplateName: string
  Title: Plan Template Name

  Maximum Length: 50

  The name of the academic plan template.

{
    "type":"object",
    "properties":{
        "BuildAcademicPlanFlag":{
            "type":"boolean",
            "description":"Indicates whether the build academic plan option for academic plan template is active or inactive.",
            "nullable":true
        },
        "instructions":{
            "title":"Instructions",
            "type":"array",
            "description":"The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-instructions-item-patch-request"
            }
        },
        "TemplateLockFlag":{
            "title":"Enable Template Lock",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the template will allow locking of template periods and elements.",
            "nullable":false
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of an institution that's associated with an academic plan template.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionId"
                ]
            }
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum units required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution value that's associated with an academic plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "AcademicLoadCode":{
            "title":"AcademicLoadCode",
            "maxLength":30,
            "type":"string",
            "description":"The code of academic load associated with the plan template such as full time or part time.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "owners":{
            "title":"Owners",
            "type":"array",
            "description":"The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-owners-item-patch-request"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the academic plan template.",
            "format":"date",
            "nullable":true
        },
        "PlanFormatId":{
            "title":"Plan Format ID",
            "type":"integer",
            "description":"The unique identifier for the associated plan format.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PlanFormatName":{
            "title":"Format Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a plan format that's associated with an academic plan template.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PlanFormatId"
                ]
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether the academic plan template is active or inactive.",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the academic plan template.",
            "format":"date",
            "nullable":true
        },
        "TemplateCode":{
            "title":"Plan Template Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code to identify the plan template.",
            "nullable":false
        },
        "MaximumCoursesQuantity":{
            "title":"Maximum Courses",
            "type":"integer",
            "description":"The maximum number of courses required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "AcademicGroupId":{
            "title":"Academic Group ID",
            "type":"integer",
            "description":"The unique identifier for an academic group value that's associated with an academic plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "LongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The description of the academic plan template.",
            "nullable":true
        },
        "CreditTypeCode":{
            "title":"Credit Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit type that's associated with an academic plan template.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TemplateName":{
            "title":"Plan Template Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic plan template.",
            "nullable":false
        },
        "periods":{
            "title":"Periods",
            "type":"array",
            "description":"The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-item-patch-request"
            }
        },
        "LockPlanFlag":{
            "title":"Lock Plan Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the lock plan option for academic plan template is active or inactive.",
            "nullable":false,
            "default":false
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum units required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Courses",
            "type":"integer",
            "description":"The minimum number of courses required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "DeleteAcademicPlanFlag":{
            "type":"boolean",
            "description":"Indicates whether the delete academic plan option for academic plan template is active or inactive.",
            "nullable":true
        }
    }
}

Nested Schema : Instructions

Type: array

Title: Instructions

The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.

Show Source

• Array of: object schema

{
    "title":"Instructions",
    "type":"array",
    "description":"The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-instructions-item-patch-request"
    }
}

Nested Schema : Owners

Type: array

Title: Owners

The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.

Show Source

• Array of: object schema

{
    "title":"Owners",
    "type":"array",
    "description":"The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-owners-item-patch-request"
    }
}

Nested Schema : Periods

Type: array

Title: Periods

The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.

Show Source

• Array of: object schema

{
    "title":"Periods",
    "type":"array",
    "description":"The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• InstructionContextCode: string
  Title: Instruction Context Code

  Maximum Length: 30

  Identifies the context of the instructions.
• InstructionOwnerId: integer (int64)
  Title: Instruction Owner ID

  The unique identifier for the instructions owner that's associated with the instructions.
• TemplateInstructionId: integer (int64)
  Title: Template Instruction ID

  The unique identifier for the template instructions associated with the academic plan template.
• TemplateInstructions: string
  The template instructions that convey academic plan requirements to the student or administrator.

{
    "type":"object",
    "properties":{
        "InstructionContextCode":{
            "title":"Instruction Context Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the context of the instructions.",
            "nullable":true
        },
        "TemplateInstructions":{
            "type":"string",
            "description":"The template instructions that convey academic plan requirements to the student or administrator.",
            "nullable":true
        },
        "InstructionOwnerId":{
            "title":"Instruction Owner ID",
            "type":"integer",
            "description":"The unique identifier for the instructions owner that's associated with the instructions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TemplateInstructionId":{
            "title":"Template Instruction ID",
            "type":"integer",
            "description":"The unique identifier for the template instructions associated with the academic plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  The unique identifier for the curriculum owner of the plan template.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  The unique identifier for the curriculum type of the owning curriculum item.
• OwningItemFlag: boolean
  Title: Primary Plan Item

  Maximum Length: 1

  Identifies the primary owning curriculum item.
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  The unique identifier for the program type of the program ownership items.
• SequenceNumber: integer (int32)
  Title: Owning Item Sequence

  Used to sequence the order of the ownership records.
• TemplateOwnerId: integer (int64)
  Title: Template Owner ID

  The unique identifier for the plan template ownership record.

{
    "type":"object",
    "properties":{
        "TemplateOwnerId":{
            "title":"Template Owner ID",
            "type":"integer",
            "description":"The unique identifier for the plan template ownership record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum owner of the plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for the program type of the program ownership items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum type of the owning curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Owning Item Sequence",
            "type":"integer",
            "description":"Used to sequence the order of the ownership records.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OwningItemFlag":{
            "title":"Primary Plan Item",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary owning curriculum item.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

  The number of contact hours required for the plan period.
• CourseCountQuantity: integer (int32)
  Title: Period Course Count

  Default Value: 0

  The courses planned for the plan period.
• elements: array Elements
  Title: Elements

  The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.
• FormatPeriodId(required): integer (int64)
  Title: Period ID

  The unique identifier for the associated plan format period.
• LockPeriodFlag(required): boolean
  Title: Lock Period

  Maximum Length: 1

  Locks the plan period, indicating the period is required.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Courses

  Default Value: 0

  The maximum number of courses required for the plan period.
• MaximumUnitsQuantity: integer (int32)
  Title: Maximum Units

  Default Value: 0

  The maximum units required for the plan period.
• MinimumCoursesQuantity: integer (int32)
  Title: Minimum Courses

  Default Value: 0

  The minimum number of courses required for the plan period.
• MinimumUnitsQuantity: integer (int32)
  Title: Minimum Units

  Default Value: 0

  The minimum units required for the plan period.
• OptionalPeriodFlag: boolean
  Title: Optional Period

  Maximum Length: 1

  Default Value: false

  Indicates that the plan period is optional.
• PeriodName(required): string
  Title: Period Name

  Maximum Length: 50

  The name of the academic plan template period.
• TemplateInstructions: string
  Title: Period Instructions

  The period instructions that convey academic plan requirements to the student or administrator.
• TemplatePeriodId: integer (int64)
  Title: Template Period ID

  The unique identifier for the academic plan template period record.
• TemplatePeriodLevelNumber(required): integer (int32)
  Title: Period Level Number

  The level of the template period within the template.
• TemplatePeriodLevelSequence(required): integer (int32)
  Title: Template Period Level Sequence

  The sequence of the plan periods within the template period level.
• TemplatePeriodOverallSequence(required): integer (int32)
  Title: Template Period Overall Sequence

  The overall sequence of the plan periods for the template.
• TemplatePeriodParentId: integer (int64)
  Title: Template Period ID

  The template period ID of the parent template period.
• tiers: array Tiers
  Title: Tiers

  The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.
• UnitCountQuantity: number
  Title: Period Unit Count

  Default Value: 0

  The units planned for the plan period.

{
    "required":[
        "FormatPeriodId",
        "LockPeriodFlag",
        "PeriodName",
        "TemplatePeriodLevelNumber",
        "TemplatePeriodLevelSequence",
        "TemplatePeriodOverallSequence"
    ],
    "type":"object",
    "properties":{
        "TemplatePeriodParentId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The template period ID of the parent template period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "tiers":{
            "title":"Tiers",
            "type":"array",
            "description":"The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-tiers-item-patch-request"
            }
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum units required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "TemplatePeriodLevelSequence":{
            "title":"Template Period Level Sequence",
            "type":"integer",
            "description":"The sequence of the plan periods within the template period level.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "TemplatePeriodLevelNumber":{
            "title":"Period Level Number",
            "type":"integer",
            "description":"The level of the template period within the template.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ContactHoursQuantity":{
            "title":"Contact Hours",
            "type":"integer",
            "description":"The number of contact hours required for the plan period.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "UnitCountQuantity":{
            "title":"Period Unit Count",
            "type":"number",
            "description":"The units planned for the plan period.",
            "nullable":true,
            "default":0
        },
        "FormatPeriodId":{
            "title":"Period ID",
            "type":"integer",
            "description":"The unique identifier for the associated plan format period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OptionalPeriodFlag":{
            "title":"Optional Period",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the plan period is optional.",
            "nullable":false,
            "default":false
        },
        "TemplatePeriodOverallSequence":{
            "title":"Template Period Overall Sequence",
            "type":"integer",
            "description":"The overall sequence of the plan periods for the template.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "MaximumCoursesQuantity":{
            "title":"Maximum Courses",
            "type":"integer",
            "description":"The maximum number of courses required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "TemplateInstructions":{
            "title":"Period Instructions",
            "type":"string",
            "description":"The period instructions that convey academic plan requirements to the student or administrator.",
            "nullable":true
        },
        "TemplatePeriodId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The unique identifier for the academic plan template period record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CourseCountQuantity":{
            "title":"Period Course Count",
            "type":"integer",
            "description":"The courses planned for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "elements":{
            "title":"Elements",
            "type":"array",
            "description":"The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-item-patch-request"
            }
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic plan template period.",
            "nullable":false,
            "x-queryable":false
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Courses",
            "type":"integer",
            "description":"The minimum number of courses required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum units required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "LockPeriodFlag":{
            "title":"Lock Period",
            "maxLength":1,
            "type":"boolean",
            "description":"Locks the plan period, indicating the period is required.",
            "nullable":false
        }
    }
}

Nested Schema : Elements

Type: array

Title: Elements

The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-elements-item-patch-request

{
    "title":"Elements",
    "type":"array",
    "description":"The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-item-patch-request"
    }
}

Nested Schema : Tiers

Type: array

Title: Tiers

The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-tiers-item-patch-request

{
    "title":"Tiers",
    "type":"array",
    "description":"The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-tiers-item-patch-request"
    }
}

Nested Schema : academicPlanTemplates-periods-elements-item-patch-request

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

  The number of contact hours required for the period element.
• courseRequisites: array Course Requisites
  Title: Course Requisites

  The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.
• DeleteActionFlag: boolean
  Title: Delete Action

  Indicates whether the delete action for curriculum course element is active or inactive.
• ElementCurriculumId(required): integer (int64)
  Title: Element Curriculum ID

  The curriculum item identifier for the curriculum course element.
• HierarchyPath: string
  The hierarchy path of the curriculum course element.
• LockElementFlag(required): boolean
  Title: Lock Element

  Maximum Length: 1

  Locks the plan template element, preventing changes or removal of the element.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Courses

  Default Value: 0

  The maximum number of courses required for the curriculum course element.
• MaximumRequiredUnitsQuantity: number
  Title: Maximum Units

  Default Value: 0

  The maximum number of units required for the curriculum course element.
• MinimumRequiredCoursesQuantity: integer (int32)
  Title: Minimum Number of Courses

  Default Value: 0

  The minimum number of courses required for the period element.
• MinimumRequiredUnitsQuantity: number
  Title: Minimum Required Units

  Default Value: 0

  The minimum units required for the period element.
• PeriodElementId: integer (int64)
  Title: Plan Period Element ID

  The unique identifier for the template period element.
• PeriodElementSequence: integer (int32)
  Title: Period Element Sequence

  The sequence of the template elements within a template period.
• relatedElements: array Related Elements
  Title: Related Elements

  The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.
• RequirementCategoryId: integer (int64)
  Title: Requirement Category ID

  The requirement category for the period element.
• SourceCurriculumId(required): integer (int64)
  Title: Source Curriculum ID

  The curriculum item identifier for the source curriculum item.
• TemplatePeriodId(required): integer (int64)
  Title: Template Period ID

  The unique identifier for the template period.

{
    "required":[
        "ElementCurriculumId",
        "LockElementFlag",
        "SourceCurriculumId",
        "TemplatePeriodId"
    ],
    "type":"object",
    "properties":{
        "PeriodElementSequence":{
            "title":"Period Element Sequence",
            "type":"integer",
            "description":"The sequence of the template elements within a template period.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "MinimumRequiredUnitsQuantity":{
            "title":"Minimum Required Units",
            "type":"number",
            "description":"The minimum units required for the period element.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            }
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The requirement category for the period element.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactHoursQuantity":{
            "title":"Contact Hours",
            "type":"integer",
            "description":"The number of contact hours required for the period element.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "ElementCurriculumId":{
            "title":"Element Curriculum ID",
            "type":"integer",
            "description":"The curriculum item identifier for the curriculum course element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MaximumCoursesQuantity":{
            "title":"Maximum Courses",
            "type":"integer",
            "description":"The maximum number of courses required for the curriculum course element.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "TemplatePeriodId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The unique identifier for the template period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "HierarchyPath":{
            "type":"string",
            "description":"The hierarchy path of the curriculum course element.",
            "nullable":true
        },
        "DeleteActionFlag":{
            "title":"Delete Action",
            "type":"boolean",
            "description":"Indicates whether the delete action for curriculum course element is active or inactive.",
            "nullable":true,
            "x-queryable":false
        },
        "courseRequisites":{
            "title":"Course Requisites",
            "type":"array",
            "description":"The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-courseRequisites-item-patch-request"
            }
        },
        "MinimumRequiredCoursesQuantity":{
            "title":"Minimum Number of Courses",
            "type":"integer",
            "description":"The minimum number of courses required for the period element.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "LockElementFlag":{
            "title":"Lock Element",
            "maxLength":1,
            "type":"boolean",
            "description":"Locks the plan template element, preventing changes or removal of the element.",
            "nullable":false
        },
        "PeriodElementId":{
            "title":"Plan Period Element ID",
            "type":"integer",
            "description":"The unique identifier for the template period element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SourceCurriculumId":{
            "title":"Source Curriculum ID",
            "type":"integer",
            "description":"The curriculum item identifier for the source curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MaximumRequiredUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"The maximum number of units required for the curriculum course element.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            }
        },
        "relatedElements":{
            "title":"Related Elements",
            "type":"array",
            "description":"The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-relatedElements-item-patch-request"
            }
        }
    }
}

Nested Schema : Course Requisites

Type: array

Title: Course Requisites

The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-elements-courseRequisites-item-patch-request

{
    "title":"Course Requisites",
    "type":"array",
    "description":"The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-courseRequisites-item-patch-request"
    }
}

Nested Schema : Related Elements

Type: array

Title: Related Elements

The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.

Show Source

• Array of: object schema

{
    "title":"Related Elements",
    "type":"array",
    "description":"The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-relatedElements-item-patch-request"
    }
}

Nested Schema : academicPlanTemplates-periods-elements-courseRequisites-item-patch-request

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

• ElementRelatedId: integer (int64)
  Title: Plan Element Related ID

  The period element relationship unique identifier.
• RelatedCurriculumId: integer (int64)
  Title: Related Curriculum ID

  The curriculum item identifier for the related curriculum item.
• RelatedLevelSequence: integer (int32)
  Title: Related Level Sequence

  The number of levels between the plan period element and the related item.

{
    "type":"object",
    "properties":{
        "RelatedCurriculumId":{
            "title":"Related Curriculum ID",
            "type":"integer",
            "description":"The curriculum item identifier for the related curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ElementRelatedId":{
            "title":"Plan Element Related ID",
            "type":"integer",
            "description":"The period element relationship unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RelatedLevelSequence":{
            "title":"Related Level Sequence",
            "type":"integer",
            "description":"The number of levels between the plan period element and the related item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

Nested Schema : academicPlanTemplates-periods-tiers-item-patch-request

Type: object

Show Source

• PeriodTierCode: string
  Title: Period Tier Code

  Maximum Length: 30

  Identifies valid academic period tiers for this plan period.
• TemplatePeriodTierId: integer (int64)
  Title: Template Period Tier ID

  The unique identifier for the plan period tier.

{
    "type":"object",
    "properties":{
        "PeriodTierCode":{
            "title":"Period Tier Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies valid academic period tiers for this plan period.",
            "nullable":false
        },
        "TemplatePeriodTierId":{
            "title":"Template Period Tier ID",
            "type":"integer",
            "description":"The unique identifier for the plan period tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : academicPlanTemplates-item-response

Type: object

Show Source

• AcademicGroupId: integer (int64)
  Title: Academic Group ID

  The unique identifier for an academic group value that's associated with an academic plan template.
• AcademicGroupName: string
  Title: Academic Group Name

  Read Only: true

  Maximum Length: 50

  The name of an academic group that's associated with an academic plan template.
• AcademicLoadCode: string
  Title: AcademicLoadCode

  Maximum Length: 30

  The code of academic load associated with the plan template such as full time or part time.
• AcademicLoadMeaning: string
  Title: AcademicLoadMeaning

  Read Only: true

  Maximum Length: 80

  The academic load associated with the plan template such as full time or part time.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 2

  Indicates whether the academic plan template is active or inactive.
• BuildAcademicPlanFlag: boolean
  Indicates whether the build academic plan option for academic plan template is active or inactive.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row for the academic plan template.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: indicates the date and time of the creation of the row for the academic plan template.
• CreditTypeCode: string
  Title: Credit Type Code

  Maximum Length: 30

  The code of the credit type that's associated with an academic plan template.
• CreditTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The credit type that's associated with an academic plan template.
• CurriculumType: string
  Title: Curriculum Type

  Read Only: true

  Maximum Length: 30

  The curriculum type that's associated with an academic plan template.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  Read Only: true

  The unique identifier for a curriculum type value that's associated with an academic plan template.
• DeleteAcademicPlanFlag: boolean
  Indicates whether the delete academic plan option for academic plan template is active or inactive.
• EndDate: string (date)
  Title: End Date

  The end date of the academic plan template.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for an institution value that's associated with an academic plan template.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The name of an institution that's associated with an academic plan template.
• instructions: array Instructions
  Title: Instructions

  The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: indicates the date and time of the last update of the row for the academic plan template.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row for the academic plan template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockPlanFlag: boolean
  Title: Lock Plan Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether the lock plan option for academic plan template is active or inactive.
• LongDescription: string
  Title: Long Description

  The description of the academic plan template.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Courses

  Default Value: 0

  The maximum number of courses required for the plan template.
• MaximumUnitsQuantity: integer (int32)
  Title: Maximum Units

  Default Value: 0

  The maximum units required for the plan template.
• MinimumCoursesQuantity: integer (int32)
  Title: Minimum Courses

  Default Value: 0

  The minimum number of courses required for the plan template.
• MinimumUnitsQuantity: integer (int32)
  Title: Minimum Units

  Default Value: 0

  The minimum units required for the plan template.
• owners: array Owners
  Title: Owners

  The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.
• periods: array Periods
  Title: Periods

  The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.
• PlanCreatedFlag: boolean
  Read Only: true

  Indicates whether the plan created option for academic plan template is active or inactive.
• PlanFormatId: integer (int64)
  Title: Plan Format ID

  The unique identifier for the associated plan format.
• PlanFormatName: string
  Title: Format Name

  Maximum Length: 50

  The name of a plan format that's associated with an academic plan template.
• StartDate: string (date)
  Title: Start Date

  The start date of the academic plan template.
• TemplateCode: string
  Title: Plan Template Code

  Maximum Length: 50

  The unique code to identify the plan template.
• TemplateId: integer (int64)
  Title: Plan Template ID

  Read Only: true

  The unique identifier for the academic plan template record.
• TemplateLockFlag: boolean
  Title: Enable Template Lock

  Maximum Length: 1

  Indicates whether the template will allow locking of template periods and elements.
• TemplateName: string
  Title: Plan Template Name

  Maximum Length: 50

  The name of the academic plan template.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row for the academic plan template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildAcademicPlanFlag":{
            "type":"boolean",
            "description":"Indicates whether the build academic plan option for academic plan template is active or inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "instructions":{
            "title":"Instructions",
            "type":"array",
            "description":"The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-instructions-item-response"
            }
        },
        "TemplateLockFlag":{
            "title":"Enable Template Lock",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the template will allow locking of template periods and elements.",
            "nullable":false,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum type value that's associated with an academic plan template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicLoadCode":{
            "title":"AcademicLoadCode",
            "maxLength":30,
            "type":"string",
            "description":"The code of academic load associated with the plan template such as full time or part time.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "owners":{
            "title":"Owners",
            "type":"array",
            "description":"The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-owners-item-response"
            }
        },
        "CreditTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The credit type that's associated with an academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanFormatId":{
            "title":"Plan Format ID",
            "type":"integer",
            "description":"The unique identifier for the associated plan format.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PlanFormatName":{
            "title":"Format Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a plan format that's associated with an academic plan template.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PlanFormatId"
                ]
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the academic plan template.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumCoursesQuantity":{
            "title":"Maximum Courses",
            "type":"integer",
            "description":"The maximum number of courses required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Plan Template Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic plan template.",
            "nullable":false,
            "x-queryable":true
        },
        "periods":{
            "title":"Periods",
            "type":"array",
            "description":"The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Courses",
            "type":"integer",
            "description":"The minimum number of courses required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Plan Template ID",
            "type":"integer",
            "description":"The unique identifier for the academic plan template record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeleteAcademicPlanFlag":{
            "type":"boolean",
            "description":"Indicates whether the delete academic plan option for academic plan template is active or inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicGroupName":{
            "title":"Academic Group Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an academic group that's associated with an academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row for the academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row for the academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of an institution that's associated with an academic plan template.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InstitutionId"
                ]
            },
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum units required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum type that's associated with an academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution value that's associated with an academic plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PlanCreatedFlag":{
            "type":"boolean",
            "description":"Indicates whether the plan created option for academic plan template is active or inactive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLoadMeaning":{
            "title":"AcademicLoadMeaning",
            "maxLength":80,
            "type":"string",
            "description":"The academic load associated with the plan template such as full time or part time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the academic plan template.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether the academic plan template is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateCode":{
            "title":"Plan Template Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code to identify the plan template.",
            "nullable":false,
            "x-queryable":true
        },
        "AcademicGroupId":{
            "title":"Academic Group ID",
            "type":"integer",
            "description":"The unique identifier for an academic group value that's associated with an academic plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The description of the academic plan template.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Credit Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit type that's associated with an academic plan template.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockPlanFlag":{
            "title":"Lock Plan Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the lock plan option for academic plan template is active or inactive.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum units required for the plan template.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row for the academic plan template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Instructions

Type: array

Title: Instructions

The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-instructions-item-response

{
    "title":"Instructions",
    "type":"array",
    "description":"The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-instructions-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 : Owners

Type: array

Title: Owners

The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-owners-item-response

{
    "title":"Owners",
    "type":"array",
    "description":"The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-owners-item-response"
    }
}

Nested Schema : Periods

Type: array

Title: Periods

The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-item-response

{
    "title":"Periods",
    "type":"array",
    "description":"The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-item-response"
    }
}

Nested Schema : academicPlanTemplates-instructions-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row with the instructions.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: indicates the date and time of the creation of the row with the instructions.
• InstructionContextCode: string
  Title: Instruction Context Code

  Maximum Length: 30

  Identifies the context of the instructions.
• InstructionOwnerId: integer (int64)
  Title: Instruction Owner ID

  The unique identifier for the instructions owner that's associated with the instructions.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: indicates the date and time of the last update of the row with the instructions.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row with the instructions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  The name of the period associated with the instructions.
• TemplateInstructionId: integer (int64)
  Title: Template Instruction ID

  The unique identifier for the template instructions associated with the academic plan template.
• TemplateInstructions: string
  The template instructions that convey academic plan requirements to the student or administrator.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row with the instructions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionContextCode":{
            "title":"Instruction Context Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the context of the instructions.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateInstructions":{
            "type":"string",
            "description":"The template instructions that convey academic plan requirements to the student or administrator.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row with the instructions.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row with the instructions.",
            "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"
            }
        },
        "InstructionOwnerId":{
            "title":"Instruction Owner ID",
            "type":"integer",
            "description":"The unique identifier for the instructions owner that's associated with the instructions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the period associated with the instructions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateInstructionId":{
            "title":"Template Instruction ID",
            "type":"integer",
            "description":"The unique identifier for the template instructions associated with the academic plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row with the instructions.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : academicPlanTemplates-owners-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row of the owning curriculum item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: indicates the date and time of the creation of the row of the owning curriculum item.
• CurriculumHeaderId: integer
  Title: Curriculum Header ID

  Read Only: true

  The unique identifier for the curriculum header of the owning curriculum item.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  The unique identifier for the curriculum owner of the plan template.
• CurriculumName: string
  Title: Curriculum Name

  Read Only: true

  The curriculum name of the owning curriculum item.
• CurriculumType: string
  Title: Curriculum Type

  Read Only: true

  Maximum Length: 30

  The curriculum type of the owning curriculum item.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  The unique identifier for the curriculum type of the owning curriculum item.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: indicates the date and time of the last update of the row of the owning curriculum item.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row of the owning curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MainProgramFlag: boolean
  Title: Main Program

  Read Only: true

  Maximum Length: 1

  Indicates whether the program is a main program.
• OwningItemFlag: boolean
  Title: Primary Plan Item

  Maximum Length: 1

  Identifies the primary owning curriculum item.
• ProgramTypeCode: string
  Title: Program Type Code

  Read Only: true

  Maximum Length: 30

  The program type code indicating the type of program.
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  The unique identifier for the program type of the program ownership items.
• ProgramTypeName: string
  Title: Program Type

  Read Only: true

  Maximum Length: 50

  The program type of the program ownership items.
• SequenceNumber: integer (int32)
  Title: Owning Item Sequence

  Used to sequence the order of the ownership records.
• TemplateOwnerId: integer (int64)
  Title: Template Owner ID

  The unique identifier for the plan template ownership record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row of the owning curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "SUPPORTS_RANGE_PAGING":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row of the owning curriculum item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row of the owning curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeCode":{
            "title":"Program Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The program type code indicating the type of program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum type of the owning curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum type of the owning curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "type":"string",
            "description":"The curriculum name of the owning curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MainProgramFlag":{
            "title":"Main Program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the program is a main program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningItemFlag":{
            "title":"Primary Plan Item",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary owning curriculum item.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateOwnerId":{
            "title":"Template Owner ID",
            "type":"integer",
            "description":"The unique identifier for the plan template ownership record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum owner of the plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for the program type of the program ownership items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Owning Item Sequence",
            "type":"integer",
            "description":"Used to sequence the order of the ownership records.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramTypeName":{
            "title":"Program Type",
            "maxLength":50,
            "type":"string",
            "description":"The program type of the program ownership items.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumHeaderId":{
            "title":"Curriculum Header ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum header of the owning curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row of the owning curriculum item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : academicPlanTemplates-periods-item-response

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

  The number of contact hours required for the plan period.
• CourseCountQuantity: integer (int32)
  Title: Period Course Count

  Default Value: 0

  The courses planned for the plan period.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row for the plan period.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: indicates the date and time of the creation of the row for the plan period.
• elements: array Elements
  Title: Elements

  The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.
• FormatPeriodId: integer (int64)
  Title: Period ID

  The unique identifier for the associated plan format period.
• InstructionContextCode: string
  Title: Instruction Context Code

  Read Only: true

  Maximum Length: 30

  Identifies the context of the instruction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: indicates the date and time of the last update of the row for the plan period.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row for the plan period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockPeriodFlag: boolean
  Title: Lock Period

  Maximum Length: 1

  Locks the plan period, indicating the period is required.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Courses

  Default Value: 0

  The maximum number of courses required for the plan period.
• MaximumUnitsQuantity: integer (int32)
  Title: Maximum Units

  Default Value: 0

  The maximum units required for the plan period.
• MinimumCoursesQuantity: integer (int32)
  Title: Minimum Courses

  Default Value: 0

  The minimum number of courses required for the plan period.
• MinimumUnitsQuantity: integer (int32)
  Title: Minimum Units

  Default Value: 0

  The minimum units required for the plan period.
• OptionalPeriodFlag: boolean
  Title: Optional Period

  Maximum Length: 1

  Default Value: false

  Indicates that the plan period is optional.
• PeriodName: string
  Title: Period Name

  Maximum Length: 50

  The name of the academic plan template period.
• TemplateInstructionId: integer (int64)
  Read Only: true

  The unique identifier for the template instruction.
• TemplateInstructions: string
  Title: Period Instructions

  The period instructions that convey academic plan requirements to the student or administrator.
• TemplatePeriodId: integer (int64)
  Title: Template Period ID

  The unique identifier for the academic plan template period record.
• TemplatePeriodLevelNumber: integer (int32)
  Title: Period Level Number

  The level of the template period within the template.
• TemplatePeriodLevelSequence: integer (int32)
  Title: Template Period Level Sequence

  The sequence of the plan periods within the template period level.
• TemplatePeriodOverallSequence: integer (int32)
  Title: Template Period Overall Sequence

  The overall sequence of the plan periods for the template.
• TemplatePeriodParentId: integer (int64)
  Title: Template Period ID

  The template period ID of the parent template period.
• tiers: array Tiers
  Title: Tiers

  The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.
• UnitCountQuantity: number
  Title: Period Unit Count

  Default Value: 0

  The units planned for the plan period.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row for the plan period.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "tiers":{
            "title":"Tiers",
            "type":"array",
            "description":"The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-tiers-item-response"
            }
        },
        "TemplatePeriodLevelSequence":{
            "title":"Template Period Level Sequence",
            "type":"integer",
            "description":"The sequence of the plan periods within the template period level.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactHoursQuantity":{
            "title":"Contact Hours",
            "type":"integer",
            "description":"The number of contact hours required for the plan period.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "UnitCountQuantity":{
            "title":"Period Unit Count",
            "type":"number",
            "description":"The units planned for the plan period.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "FormatPeriodId":{
            "title":"Period ID",
            "type":"integer",
            "description":"The unique identifier for the associated plan format period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptionalPeriodFlag":{
            "title":"Optional Period",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the plan period is optional.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MaximumCoursesQuantity":{
            "title":"Maximum Courses",
            "type":"integer",
            "description":"The maximum number of courses required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplateInstructions":{
            "title":"Period Instructions",
            "type":"string",
            "description":"The period instructions that convey academic plan requirements to the student or administrator.",
            "nullable":true,
            "x-queryable":true
        },
        "CourseCountQuantity":{
            "title":"Period Course Count",
            "type":"integer",
            "description":"The courses planned for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TemplateInstructionId":{
            "type":"integer",
            "description":"The unique identifier for the template instruction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Courses",
            "type":"integer",
            "description":"The minimum number of courses required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LockPeriodFlag":{
            "title":"Lock Period",
            "maxLength":1,
            "type":"boolean",
            "description":"Locks the plan period, indicating the period is required.",
            "nullable":false,
            "x-queryable":true
        },
        "InstructionContextCode":{
            "title":"Instruction Context Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the context of the instruction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row for the plan period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplatePeriodParentId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The template period ID of the parent template period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row for the plan period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum units required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplatePeriodLevelNumber":{
            "title":"Period Level Number",
            "type":"integer",
            "description":"The level of the template period within the template.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplatePeriodOverallSequence":{
            "title":"Template Period Overall Sequence",
            "type":"integer",
            "description":"The overall sequence of the plan periods for the template.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplatePeriodId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The unique identifier for the academic plan template period record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "elements":{
            "title":"Elements",
            "type":"array",
            "description":"The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-item-response"
            }
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic plan template period.",
            "nullable":false,
            "x-queryable":false
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum units required for the plan period.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row for the plan period.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Elements

Type: array

Title: Elements

The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-elements-item-response

{
    "title":"Elements",
    "type":"array",
    "description":"The elements resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-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 : Tiers

Type: array

Title: Tiers

The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-tiers-item-response

{
    "title":"Tiers",
    "type":"array",
    "description":"The tiers resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-tiers-item-response"
    }
}

Nested Schema : academicPlanTemplates-periods-elements-item-response

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

  The number of contact hours required for the period element.
• courseRequisites: array Course Requisites
  Title: Course Requisites

  The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row for the curriculum course element.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: indicates the date and time of the creation of the row for the curriculum course element.
• CreditTypeMeaning: string
  Title: Type of Credit Meaning

  Read Only: true

  Maximum Length: 80

  The credit type that's associated with the curriculum course element.
• DeleteActionFlag: boolean
  Title: Delete Action

  Indicates whether the delete action for curriculum course element is active or inactive.
• ElementCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The catalog number of the curriculum course element.
• ElementCurriculumId: integer (int64)
  Title: Element Curriculum ID

  The curriculum item identifier for the curriculum course element.
• ElementCurriculumName: string
  Title: Element Curriculum Name

  Read Only: true

  Maximum Length: 50

  The curriculum item name of the curriculum course element.
• ElementCurriculumType: string
  Title: Element Curriculum Type

  Read Only: true

  Maximum Length: 30

  The curriculum item type of the curriculum course element.
• ElementCurriculumTypeId: integer (int64)
  Title: Element Curriculum Type ID

  Read Only: true

  The curriculum item type identifier for the curriculum course element.
• ElementCurriculumTypeName: string
  Title: Element Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The curriculum item type name of the curriculum course element.
• ElementSubjectCode: string
  Title: Element Subject Code

  Read Only: true

  Maximum Length: 30

  The curriculum item subject code of the curriculum course element.
• HierarchyPath: string
  The hierarchy path of the curriculum course element.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: indicates the date and time of the last update of the row for the curriculum course element.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row for the curriculum course element.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockElementFlag: boolean
  Title: Lock Element

  Maximum Length: 1

  Locks the plan template element, preventing changes or removal of the element.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Courses

  Default Value: 0

  The maximum number of courses required for the curriculum course element.
• MaximumRequiredUnitsQuantity: number
  Title: Maximum Units

  Default Value: 0

  The maximum number of units required for the curriculum course element.
• MaximumUnitsQuantity: number
  Title: Maximum Units

  Read Only: true

  The maximum units required for the curriculum course element.
• MinimumRequiredCoursesQuantity: integer (int32)
  Title: Minimum Number of Courses

  Default Value: 0

  The minimum number of courses required for the period element.
• MinimumRequiredUnitsQuantity: number
  Title: Minimum Required Units

  Default Value: 0

  The minimum units required for the period element.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  The minimum units required for the curriculum course element.
• PeriodElementId: integer (int64)
  Title: Plan Period Element ID

  The unique identifier for the template period element.
• PeriodElementSequence: integer (int32)
  Title: Period Element Sequence

  The sequence of the template elements within a template period.
• relatedElements: array Related Elements
  Title: Related Elements

  The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.
• RequirementCategoryId: integer (int64)
  Title: Requirement Category ID

  The requirement category for the period element.
• SourceCurriculumId: integer (int64)
  Title: Source Curriculum ID

  The curriculum item identifier for the source curriculum item.
• SourceCurriculumName: string
  Title: Source Curriculum Name

  Read Only: true

  Maximum Length: 50

  The curriculum item name of the requirement source curriculum item.
• SourceCurriculumType: string
  Title: Source Curriculum Type

  Read Only: true

  Maximum Length: 30

  The curriculum item type of the requirement source curriculum item.
• SourceCurriculumTypeId: integer (int64)
  Title: Source Curriculum Type ID

  Read Only: true

  The curriculum item type identifier for the requirement source curriculum item.
• SourceCurriculumTypeName: string
  Title: Source Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The curriculum item type name of the requirement source curriculum item.
• TemplatePeriodId: integer (int64)
  Title: Template Period ID

  The unique identifier for the template period.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row for the curriculum course element.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCurriculumType":{
            "title":"Source Curriculum Type",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum item type of the requirement source curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactHoursQuantity":{
            "title":"Contact Hours",
            "type":"integer",
            "description":"The number of contact hours required for the period element.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ElementCurriculumId":{
            "title":"Element Curriculum ID",
            "type":"integer",
            "description":"The curriculum item identifier for the curriculum course element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceCurriculumTypeName":{
            "title":"Source Curriculum Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The curriculum item type name of the requirement source curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCurriculumTypeId":{
            "title":"Source Curriculum Type ID",
            "type":"integer",
            "description":"The curriculum item type identifier for the requirement source curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The credit type that's associated with the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumCoursesQuantity":{
            "title":"Maximum Courses",
            "type":"integer",
            "description":"The maximum number of courses required for the curriculum course element.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ElementCurriculumTypeId":{
            "title":"Element Curriculum Type ID",
            "type":"integer",
            "description":"The curriculum item type identifier for the curriculum course element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ElementSubjectCode":{
            "title":"Element Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum item subject code of the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementCurriculumType":{
            "title":"Element Curriculum Type",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum item type of the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteActionFlag":{
            "title":"Delete Action",
            "type":"boolean",
            "description":"Indicates whether the delete action for curriculum course element is active or inactive.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MaximumRequiredUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"The maximum number of units required for the curriculum course element.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "ElementCurriculumName":{
            "title":"Element Curriculum Name",
            "maxLength":50,
            "type":"string",
            "description":"The curriculum item name of the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row for the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodElementSequence":{
            "title":"Period Element Sequence",
            "type":"integer",
            "description":"The sequence of the template elements within a template period.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MinimumRequiredUnitsQuantity":{
            "title":"Minimum Required Units",
            "type":"number",
            "description":"The minimum units required for the period element.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "ElementCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number of the curriculum course element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row for the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"The minimum units required for the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The requirement category for the period element.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceCurriculumName":{
            "title":"Source Curriculum Name",
            "maxLength":50,
            "type":"string",
            "description":"The curriculum item name of the requirement source curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplatePeriodId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The unique identifier for the template period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "HierarchyPath":{
            "type":"string",
            "description":"The hierarchy path of the curriculum course element.",
            "nullable":true,
            "x-queryable":true
        },
        "courseRequisites":{
            "title":"Course Requisites",
            "type":"array",
            "description":"The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-courseRequisites-item-response"
            }
        },
        "ElementCurriculumTypeName":{
            "title":"Element Curriculum Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The curriculum item type name of the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumRequiredCoursesQuantity":{
            "title":"Minimum Number of Courses",
            "type":"integer",
            "description":"The minimum number of courses required for the period element.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LockElementFlag":{
            "title":"Lock Element",
            "maxLength":1,
            "type":"boolean",
            "description":"Locks the plan template element, preventing changes or removal of the element.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodElementId":{
            "title":"Plan Period Element ID",
            "type":"integer",
            "description":"The unique identifier for the template period element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"The maximum units required for the curriculum course element.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "SourceCurriculumId":{
            "title":"Source Curriculum ID",
            "type":"integer",
            "description":"The curriculum item identifier for the source curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row for the curriculum course element.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "relatedElements":{
            "title":"Related Elements",
            "type":"array",
            "description":"The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.",
            "items":{
                "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-relatedElements-item-response"
            }
        }
    }
}

Nested Schema : Course Requisites

Type: array

Title: Course Requisites

The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-elements-courseRequisites-item-response

{
    "title":"Course Requisites",
    "type":"array",
    "description":"The courseRequisites resource is a child of the academic plan templates resource and provides a list of tiers associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-courseRequisites-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 : Related Elements

Type: array

Title: Related Elements

The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.

Show Source

• Array of: object academicPlanTemplates-periods-elements-relatedElements-item-response

{
    "title":"Related Elements",
    "type":"array",
    "description":"The related elements resource is a child of the academic plan templates resource and provides a list of related elements associated with an academic plan template.",
    "items":{
        "$ref":"#/components/schemas/academicPlanTemplates-periods-elements-relatedElements-item-response"
    }
}

Nested Schema : academicPlanTemplates-periods-elements-courseRequisites-item-response

Type: object

Show Source

• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The academic subject of the course requisite in the academic plan template.
• AcademicSubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

  The unique identifier for the academic subject for the course requisite.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The curriculum catalog number of the course requisite in the academic plan template.
• CurriculumCourseId: integer (int64)
  Read Only: true

  The unique identifier for the curriculum course for the curriculum course requisite.
• CurriculumHeaderId: integer (int64)
  Read Only: true

  The unique identifier for the curriculum header of the course requisite.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The unique identifier for the curriculum for the curriculum course requisite.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The curriculum name of the course requisite in the academic plan template.
• CurriculumOfferingId: integer (int64)
  Read Only: true

  The unique identifier for the curriculum offering for the course requisite.
• CurriculumRequisiteId: integer (int64)
  Read Only: true

  The unique identifier for the curriculum requisite for the curriculum course requisite.
• EffectiveEndDate: string (date)
  Read Only: true

  The effective end date of the course requisite in the academic plan template.
• EffectiveStartDate: string (date)
  Read Only: true

  The effective start date of the course requisite in the academic plan template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferStandard: string
  Read Only: true

  The offer standard of the course requisite in the academic plan template.
• RequisiteCurriculumId: integer (int64)
  Read Only: true

  The unique identifier for the requisite curriculum for the curriculum course requisite.
• RequisiteCurriculumName: string
  Title: Requisite Curriculum Name

  Read Only: true

  The requisite curriculum name of the course requisite in the academic plan template.
• RequisiteTypeCode: string
  Read Only: true

  Maximum Length: 30

  The requisite type of the course requisite in the academic plan template.

{
    "type":"object",
    "properties":{
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The curriculum catalog number of the course requisite in the academic plan template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The effective end date of the course requisite in the academic plan template.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The curriculum name of the course requisite in the academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumOfferingId":{
            "type":"integer",
            "description":"The unique identifier for the curriculum offering for the course requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisiteCurriculumId":{
            "type":"integer",
            "description":"The unique identifier for the requisite curriculum for the curriculum course requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisiteTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The requisite type of the course requisite in the academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The academic subject of the course requisite in the academic plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteCurriculumName":{
            "title":"Requisite Curriculum Name",
            "type":"string",
            "description":"The requisite curriculum name of the course requisite in the academic plan template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumCourseId":{
            "type":"integer",
            "description":"The unique identifier for the curriculum course for the curriculum course requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumRequisiteId":{
            "type":"integer",
            "description":"The unique identifier for the curriculum requisite for the curriculum course requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum for the curriculum course requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for the academic subject for the course requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OfferStandard":{
            "type":"string",
            "description":"The offer standard of the course requisite in the academic plan template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumHeaderId":{
            "type":"integer",
            "description":"The unique identifier for the curriculum header of the course requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The effective start date of the course requisite in the academic plan template.",
            "format":"date",
            "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 : academicPlanTemplates-periods-elements-relatedElements-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row of the related curriculum item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: indicates the date and time of the creation of the row of the related curriculum item.
• ElementRelatedId: integer (int64)
  Title: Plan Element Related ID

  The period element relationship unique identifier.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: indicates the date and time of the last update of the row of the related curriculum item.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row of the related curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelatedCurriculumId: integer (int64)
  Title: Related Curriculum ID

  The curriculum item identifier for the related curriculum item.
• RelatedCurriculumType: string
  Title: Related Curriculum Type

  Read Only: true

  Maximum Length: 30

  The curriculum item type of the related curriculum item.
• RelatedCurriculumTypeId: integer (int64)
  Title: Related Curriculum Type ID

  Read Only: true

  The curriculum item type identifier for the related curriculum item.
• RelatedCurriculumTypeName: string
  Title: Related Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The curriculum item type name of the related curriculum item.
• RelatedLevelSequence: integer (int32)
  Title: Related Level Sequence

  The number of levels between the plan period element and the related item.

{
    "type":"object",
    "properties":{
        "RelatedCurriculumTypeName":{
            "title":"Related Curriculum Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The curriculum item type name of the related curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row of the related curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedCurriculumId":{
            "title":"Related Curriculum ID",
            "type":"integer",
            "description":"The curriculum item identifier for the related curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row of the related curriculum item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row of the related curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementRelatedId":{
            "title":"Plan Element Related ID",
            "type":"integer",
            "description":"The period element relationship unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RelatedLevelSequence":{
            "title":"Related Level Sequence",
            "type":"integer",
            "description":"The number of levels between the plan period element and the related item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedCurriculumTypeId":{
            "title":"Related Curriculum Type ID",
            "type":"integer",
            "description":"The curriculum item type identifier for the related curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedCurriculumType":{
            "title":"Related Curriculum Type",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum item type of the related curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row of the related curriculum item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : academicPlanTemplates-periods-tiers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row for the plan period tier.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: indicates the date and time of the creation of the row for the plan period tier.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: indicates the date and time of the last update of the row for the plan period tier.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row for the plan period tier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodTierCode: string
  Title: Period Tier Code

  Maximum Length: 30

  Identifies valid academic period tiers for this plan period.
• PeriodTierMeaning: string
  Title: Period Tier Meaning

  Read Only: true

  Maximum Length: 80

  The academic period tier that's associated with this plan period.
• TemplatePeriodTierId: integer (int64)
  Title: Template Period Tier ID

  The unique identifier for the plan period tier.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row for the plan period tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row for the plan period tier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row for the plan period tier.",
            "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"
            }
        },
        "TemplatePeriodTierId":{
            "title":"Template Period Tier ID",
            "type":"integer",
            "description":"The unique identifier for the plan period tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PeriodTierMeaning":{
            "title":"Period Tier Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The academic period tier that's associated with this plan period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodTierCode":{
            "title":"Period Tier Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies valid academic period tiers for this plan period.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row for the plan period tier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

AcademicGroupLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicGroups

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicGroupId; Target Attribute: AcademicGroupId
• Display Attribute: CurriculumName

AcademicInstitutionLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

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

AcademicLoadHerLookupPVO1

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicLoadCode; Target Attribute: LookupCode
• Display Attribute: DisplayedField

CreditTypeHerLookupPVO1

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

The following properties are defined on the LOV link relation:

• Source Attribute: CreditTypeCode; Target Attribute: LookupCode
• Display Attribute: DisplayedField

PlanFormatLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicPlanFormats

The following properties are defined on the LOV link relation:

• Source Attribute: PlanFormatName; Target Attribute: PlanFormatName
• Display Attribute: PlanFormatName

instructions

Operation: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/instructions

Parameters:

• academicPlanTemplatesUniqID: $request.path.academicPlanTemplatesUniqID

The instructions resource is a child of the academic plan templates resource and provides a list of instructions associated with an academic plan template.

owners

Operation: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/owners

Parameters:

• academicPlanTemplatesUniqID: $request.path.academicPlanTemplatesUniqID

The owners resource is a child of the academic plan templates resource and provides a list of curriculum items associated with an academic plan template.

periods

Operation: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods

Parameters:

• academicPlanTemplatesUniqID: $request.path.academicPlanTemplatesUniqID

The periods resource is a child of the academic plan templates resource and provides a list of academic periods associated with an academic plan template.

Back to Top