Jump to

• Request
• Response

Update a student academic plan

patch

/fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}

Request

Path Parameters

• studentAcademicPlansUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Student Academic Plans resource and used to uniquely identify an instance of Student Academic Plans. The client should not generate the hash key value. Instead, the client should query on the Student Academic Plans collection resource in order to navigate to a specific instance of Student Academic Plans 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

• CommentText: string
  Title: Comment Text

  The attribute to store student's comments or notes for the academic plan.
• conflicts: array Conflicts
  Title: Conflicts

  The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.
• InstitutionId: integer (int64)
  Title: Institution ID

  Unique identifier for the associated institution.
• items: array Items
  Title: Items

  The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.
• 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

  Unique identifier for the associated plan format.
• PlanId: integer (int64)
  Title: Academic Plan ID

  Unique identifier for a student academic plan.
• PlanName(required): string
  Title: Academic Plan Name

  Maximum Length: 50

  The name of the student academic plan.
• PlannedGraduationDate: string (date)
  Title: Planned Graduation Date

  The student planned graduation date.
• TemplateId: integer (int64)
  Title: Plan Template ID

  Unique identifier for the associated plan template.

{
    "required":[
        "PlanName"
    ],
    "type":"object",
    "properties":{
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"Unique identifier for the associated institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PlanId":{
            "title":"Academic Plan ID",
            "type":"integer",
            "description":"Unique identifier for a student academic plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CommentText":{
            "title":"Comment Text",
            "type":"string",
            "description":"The attribute to store student's comments or notes for the academic plan.",
            "nullable":true
        },
        "conflicts":{
            "title":"Conflicts",
            "type":"array",
            "description":"The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-conflicts-item-patch-request"
            }
        },
        "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/studentAcademicPlans-periods-item-patch-request"
            }
        },
        "PlanName":{
            "title":"Academic Plan Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the student academic plan.",
            "nullable":false
        },
        "PlanFormatId":{
            "title":"Plan Format ID",
            "type":"integer",
            "description":"Unique identifier for the associated plan format.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-items-item-patch-request"
            }
        },
        "TemplateId":{
            "title":"Plan Template ID",
            "type":"integer",
            "description":"Unique identifier for the associated plan template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PlannedGraduationDate":{
            "title":"Planned Graduation Date",
            "type":"string",
            "description":"The student planned graduation date.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : Conflicts

Type: array

Title: Conflicts

The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.

Show Source

• Array of: object studentAcademicPlans-conflicts-item-patch-request

{
    "title":"Conflicts",
    "type":"array",
    "description":"The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.",
    "items":{
        "$ref":"#/components/schemas/studentAcademicPlans-conflicts-item-patch-request"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.

Show Source

• Array of: object studentAcademicPlans-items-item-patch-request

{
    "title":"Items",
    "type":"array",
    "description":"The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.",
    "items":{
        "$ref":"#/components/schemas/studentAcademicPlans-items-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/studentAcademicPlans-periods-item-patch-request"
    }
}

Nested Schema : studentAcademicPlans-conflicts-item-patch-request

Type: object

Show Source

• ConflictContextCode: string
  Title: Conflict Context Code

  Maximum Length: 30

  The context code of the plan conflict.
• ConflictId: integer (int64)
  Title: Plan Conflict ID

  The unique identifier for the plan conflict.
• ConflictReferenceId: integer (int64)
  Title: Conflict Reference ID

  Unique identifier for the source of the edit conflict.
• FifthTokenName: string
  Title: Message Token 5 Name

  Maximum Length: 30

  The fifth token for the message text.
• FifthTokenValue: string
  Title: Message Token 5 Value

  Maximum Length: 80

  The fifth token value for the message text.
• FirstTokenName: string
  Title: Message Token 1 Name

  Maximum Length: 30

  The first token for the message text.
• FirstTokenValue: string
  Title: Message Token Value 1

  Maximum Length: 80

  The first token value for the message text.
• FourthTokenName: string
  Title: Message Token 4 Name

  Maximum Length: 30

  The fourth token for the message text.
• FourthTokenValue: string
  Title: Message Token 4 Value

  Maximum Length: 80

  The fourth token value for the message text.
• MessageName: string
  Title: Message Name

  Maximum Length: 30

  The message identifier for the plan conflict.
• MessageSeverityCode: string
  Title: Message Severity Code

  Maximum Length: 30

  The severity code of the conflict message.
• MessageText: string
  Title: Message Text

  The stack trace or the text of the conflict message.
• SecondTokenName: string
  Title: Message Token 2 Name

  Maximum Length: 30

  The second token for the message text.
• SecondTokenValue: string
  Title: Message Token 2 Value

  Maximum Length: 80

  The second token value for the message text.
• ThirdTokenName: string
  Title: Message Token 3 Name

  Maximum Length: 30

  The third token for the message text.
• ThirdTokenValue: string
  Title: Message Token 3 Value

  Maximum Length: 80

  The third token value for the message text.

{
    "type":"object",
    "properties":{
        "MessageSeverityCode":{
            "title":"Message Severity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The severity code of the conflict message.",
            "nullable":true
        },
        "ThirdTokenValue":{
            "title":"Message Token 3 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The third token value for the message text.",
            "nullable":true
        },
        "FifthTokenValue":{
            "title":"Message Token 5 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The fifth token value for the message text.",
            "nullable":true
        },
        "FourthTokenValue":{
            "title":"Message Token 4 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The fourth token value for the message text.",
            "nullable":true
        },
        "MessageText":{
            "title":"Message Text",
            "type":"string",
            "description":"The stack trace or the text of the conflict message.",
            "nullable":true
        },
        "ConflictContextCode":{
            "title":"Conflict Context Code",
            "maxLength":"30",
            "type":"string",
            "description":"The context code of the plan conflict.",
            "nullable":true
        },
        "ConflictReferenceId":{
            "title":"Conflict Reference ID",
            "type":"integer",
            "description":"Unique identifier for the source of the edit conflict.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConflictId":{
            "title":"Plan Conflict ID",
            "type":"integer",
            "description":"The unique identifier for the plan conflict.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":"30",
            "type":"string",
            "description":"The message identifier for the plan conflict.",
            "nullable":true
        },
        "FifthTokenName":{
            "title":"Message Token 5 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The fifth token for the message text.",
            "nullable":true
        },
        "FirstTokenName":{
            "title":"Message Token 1 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The first token for the message text.",
            "nullable":true
        },
        "FourthTokenName":{
            "title":"Message Token 4 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The fourth token for the message text.",
            "nullable":true
        },
        "SecondTokenName":{
            "title":"Message Token 2 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The second token for the message text.",
            "nullable":true
        },
        "FirstTokenValue":{
            "title":"Message Token Value 1",
            "maxLength":"80",
            "type":"string",
            "description":"The first token value for the message text.",
            "nullable":true
        },
        "ThirdTokenName":{
            "title":"Message Token 3 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The third token for the message text.",
            "nullable":true
        },
        "SecondTokenValue":{
            "title":"Message Token 2 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The second token value for the message text.",
            "nullable":true
        }
    }
}

Nested Schema : studentAcademicPlans-items-item-patch-request

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  Unique identifier for a curriculum item.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  Unique identifier for the type category of a curriculum item.
• ItemId: integer (int64)
  Title: Planned Item ID

  Unique identifier for a plan item.
• PlanItemFlag: boolean
  Title: Primary Plan Item

  Maximum Length: 1

  Default Value: false

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

  The unique identifier for a program type that's associated with a program.
• SequenceNumber: integer (int32)
  Title: Plan Item Sequence

  Used to sequence the order of the plan item.

{
    "type":"object",
    "properties":{
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier for a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type that's associated with a program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"Unique identifier for the type category of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PlanItemFlag":{
            "title":"Primary Plan Item",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies the primary curriculum item for the plan.",
            "nullable":false,
            "default":false
        },
        "SequenceNumber":{
            "title":"Plan Item Sequence",
            "type":"integer",
            "description":"Used to sequence the order of the plan item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ItemId":{
            "title":"Planned Item ID",
            "type":"integer",
            "description":"Unique identifier for a plan item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• elements: array Elements
  Title: Elements

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

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

  Maximum Length: 1

  Default Value: false

  Locks the plan period, indicating the period is required.
• PeriodCourseCountQuantity: integer (int32)
  Title: Period Course Count

  The courses planned for the plan period.
• PeriodSequence: integer (int32)
  Title: Period Sequence Number

  Sequence of the plan format period within a level.
• PeriodUnitCountQuantity: number
  Title: Period Unit Count

  The units planned for the plan period.
• PlanPeriodId: integer (int64)
  Title: Plan Period ID

  The unique identifier for the plan period.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Unique identifier for the student academic plan reporting period.
• ScheduleEnabledFlag: boolean
  Indicates whether the period can be used to create a scheduler.
• TemplatePeriodId: integer (int64)
  Title: Template Period ID

  The unique identifier for the academic plan template period record.

{
    "type":"object",
    "properties":{
        "TemplatePeriodId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The unique identifier for the academic plan template period record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ScheduleEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the period can be used to create a scheduler.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReportingPeriodId"
                ]
            }
        },
        "PeriodCourseCountQuantity":{
            "title":"Period Course Count",
            "type":"integer",
            "description":"The courses planned for the plan period.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "PeriodSequence":{
            "title":"Period Sequence Number",
            "type":"integer",
            "description":"Sequence of the plan format period within a level.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "PlanPeriodId":{
            "title":"Plan Period ID",
            "type":"integer",
            "description":"The unique identifier for the plan period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "elements":{
            "title":"Elements",
            "type":"array",
            "description":"The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-periods-elements-item-patch-request"
            }
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"Unique identifier for the student academic plan reporting period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "FormatPeriodId":{
            "title":"Period ID",
            "type":"integer",
            "description":"The unique identifier for the associated plan format period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LockPeriodFlag":{
            "title":"Lock Period",
            "maxLength":"1",
            "type":"boolean",
            "description":"Locks the plan period, indicating the period is required.",
            "nullable":false,
            "default":false
        },
        "PeriodUnitCountQuantity":{
            "title":"Period Unit Count",
            "type":"number",
            "description":"The units planned for the plan period.",
            "nullable":true
        }
    }
}

Nested Schema : Elements

Type: array

Title: Elements

The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan.

Show Source

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

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

Nested Schema : studentAcademicPlans-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.
• DeleteActionFlag: boolean
  Title: Delete Action

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

  The curriculum item identifier for the curriculum course element.
• LockElementFlag: boolean
  Title: Lock Element

  Maximum Length: 1

  Default Value: false

  Locks the plan template element, preventing changes or removal of the element.
• MinimumRequiredUnitsQuantity: number
  Title: Minimum Required Units

  The minimum units required for the period element.
• NumberOfUnitsTakenQuantity: number
  Title: Number of Units Taken

  The number of units taken for the period element.
• PeriodElementId: integer (int64)
  Title: Plan Period Element ID

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

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

  The related elements resource is a child of the elements resource and provides a list of related elements associated with a student academic plan.
• SourceCurriculumId: integer (int64)
  Title: Source Curriculum ID

  Unique identifier for the requirement source curriculum item.

{
    "required":[
        "PeriodElementSequence"
    ],
    "type":"object",
    "properties":{
        "PeriodElementSequence":{
            "title":"Period Element Sequence",
            "type":"integer",
            "description":"The sequence of the plan elements within a plan 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,
            "x-hints":{
                "precision":"11",
                "scale":"2"
            }
        },
        "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
        },
        "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":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LockElementFlag":{
            "title":"Lock Element",
            "maxLength":"1",
            "type":"boolean",
            "description":"Locks the plan template element, preventing changes or removal of the element.",
            "nullable":false,
            "default":false
        },
        "PeriodElementId":{
            "title":"Plan Period Element ID",
            "type":"integer",
            "description":"The unique identifier for the plan period element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SourceCurriculumId":{
            "title":"Source Curriculum ID",
            "type":"integer",
            "description":"Unique identifier for the requirement source curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NumberOfUnitsTakenQuantity":{
            "title":"Number of Units Taken",
            "type":"number",
            "description":"The number of units taken for the period element.",
            "nullable":true,
            "x-hints":{
                "precision":"11",
                "scale":"2"
            }
        },
        "relatedElements":{
            "title":"Related Elements",
            "type":"array",
            "description":"The related elements resource is a child of the elements resource and provides a list of related elements associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-periods-elements-relatedElements-item-patch-request"
            }
        }
    }
}

Nested Schema : Related Elements

Type: array

Title: Related Elements

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

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

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

  The curriculum item identifier for the related curriculum item.
• RelatedCurriculumId: integer (int64)
  Title: Related Curriculum ID

  The plan element relationship unique identifier.
• RelatedLevelSequence: integer (int32)
  Title: Related Level Sequence

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

{
    "type":"object",
    "properties":{
        "RelatedCurriculumId":{
            "title":"Related Curriculum ID",
            "type":"integer",
            "description":"The plan element relationship unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ElementRelatedId":{
            "title":"Plan Element Related ID",
            "type":"integer",
            "description":"The curriculum item identifier for the related curriculum item.",
            "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 element and the related item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : studentAcademicPlans-item-response

Type: object

Show Source

• CommentText: string
  Title: Comment Text

  The attribute to store student's comments or notes for the academic plan.
• CommentUpdateDateTime: string
  Title: Comment Update Date Time

  Read Only: true

  Indicates the date and time of the last update of the comment for the student academic plan.
• conflicts: array Conflicts
  Title: Conflicts

  The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.
• InstitutionId: integer (int64)
  Title: Institution ID

  Unique identifier for the associated institution.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the associated institution.
• items: array Items
  Title: Items

  The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.
• LastUpdateDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the last update of the row for the student academic plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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

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

  Read Only: true

  Maximum Length: 50

  The name of the associated plan format.
• PlanId: integer (int64)
  Title: Academic Plan ID

  Unique identifier for a student academic plan.
• PlanName: string
  Title: Academic Plan Name

  Maximum Length: 50

  The name of the student academic plan.
• PlannedGraduationDate: string (date)
  Title: Planned Graduation Date

  The student planned graduation date.
• PlanStatusCode: string
  Title: Academic Plan Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The status code of the student academic plan.
• PlanStatusCodeMeaning: string
  Title: Plan Status Code Meaning

  Read Only: true

  Maximum Length: 80

  The status code meaning of the student academic plan.
• TemplateId: integer (int64)
  Title: Plan Template ID

  Unique identifier for the associated plan template.
• TemplateName: string
  Title: Plan Template Name

  Read Only: true

  Maximum Length: 50

  The name of the associated plan template.

{
    "type":"object",
    "properties":{
        "PlanStatusCodeMeaning":{
            "title":"Plan Status Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The status code meaning of the student academic plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the associated institution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"Unique identifier for the associated institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanId":{
            "title":"Academic Plan ID",
            "type":"integer",
            "description":"Unique identifier for a student academic plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comment Text",
            "type":"string",
            "description":"The attribute to store student's comments or notes for the academic plan.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanName":{
            "title":"Academic Plan Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the student academic plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanFormatName":{
            "title":"Format Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the associated plan format.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanFormatId":{
            "title":"Plan Format ID",
            "type":"integer",
            "description":"Unique identifier for the associated plan format.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanStatusCode":{
            "title":"Academic Plan Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the student academic plan.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Plan Template Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the associated plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentUpdateDateTime":{
            "title":"Comment Update Date Time",
            "type":"string",
            "description":"Indicates the date and time of the last update of the comment for the student academic plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "conflicts":{
            "title":"Conflicts",
            "type":"array",
            "description":"The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-conflicts-item-response"
            }
        },
        "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/studentAcademicPlans-periods-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-items-item-response"
            }
        },
        "TemplateId":{
            "title":"Plan Template ID",
            "type":"integer",
            "description":"Unique identifier for the associated plan template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row for the student academic plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedGraduationDate":{
            "title":"Planned Graduation Date",
            "type":"string",
            "description":"The student planned graduation date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Conflicts

Type: array

Title: Conflicts

The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.

Show Source

• Array of: object studentAcademicPlans-conflicts-item-response

{
    "title":"Conflicts",
    "type":"array",
    "description":"The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.",
    "items":{
        "$ref":"#/components/schemas/studentAcademicPlans-conflicts-item-response"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.

Show Source

• Array of: object studentAcademicPlans-items-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.",
    "items":{
        "$ref":"#/components/schemas/studentAcademicPlans-items-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 : 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 studentAcademicPlans-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/studentAcademicPlans-periods-item-response"
    }
}

Nested Schema : studentAcademicPlans-conflicts-item-response

Type: object

Show Source

• ConflictContextCode: string
  Title: Conflict Context Code

  Maximum Length: 30

  The context code of the plan conflict.
• ConflictId: integer (int64)
  Title: Plan Conflict ID

  The unique identifier for the plan conflict.
• ConflictReferenceId: integer (int64)
  Title: Conflict Reference ID

  Unique identifier for the source of the edit conflict.
• FifthTokenName: string
  Title: Message Token 5 Name

  Maximum Length: 30

  The fifth token for the message text.
• FifthTokenValue: string
  Title: Message Token 5 Value

  Maximum Length: 80

  The fifth token value for the message text.
• FirstTokenName: string
  Title: Message Token 1 Name

  Maximum Length: 30

  The first token for the message text.
• FirstTokenValue: string
  Title: Message Token Value 1

  Maximum Length: 80

  The first token value for the message text.
• FourthTokenName: string
  Title: Message Token 4 Name

  Maximum Length: 30

  The fourth token for the message text.
• FourthTokenValue: string
  Title: Message Token 4 Value

  Maximum Length: 80

  The fourth token value for the message text.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageName: string
  Title: Message Name

  Maximum Length: 30

  The message identifier for the plan conflict.
• MessageSeverityCode: string
  Title: Message Severity Code

  Maximum Length: 30

  The severity code of the conflict message.
• MessageText: string
  Title: Message Text

  The stack trace or the text of the conflict message.
• SecondTokenName: string
  Title: Message Token 2 Name

  Maximum Length: 30

  The second token for the message text.
• SecondTokenValue: string
  Title: Message Token 2 Value

  Maximum Length: 80

  The second token value for the message text.
• ThirdTokenName: string
  Title: Message Token 3 Name

  Maximum Length: 30

  The third token for the message text.
• ThirdTokenValue: string
  Title: Message Token 3 Value

  Maximum Length: 80

  The third token value for the message text.

{
    "type":"object",
    "properties":{
        "MessageSeverityCode":{
            "title":"Message Severity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The severity code of the conflict message.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdTokenValue":{
            "title":"Message Token 3 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The third token value for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "FifthTokenValue":{
            "title":"Message Token 5 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The fifth token value for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "FourthTokenValue":{
            "title":"Message Token 4 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The fourth token value for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageText":{
            "title":"Message Text",
            "type":"string",
            "description":"The stack trace or the text of the conflict message.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictContextCode":{
            "title":"Conflict Context Code",
            "maxLength":"30",
            "type":"string",
            "description":"The context code of the plan conflict.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictReferenceId":{
            "title":"Conflict Reference ID",
            "type":"integer",
            "description":"Unique identifier for the source of the edit conflict.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Plan Conflict ID",
            "type":"integer",
            "description":"The unique identifier for the plan conflict.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":"30",
            "type":"string",
            "description":"The message identifier for the plan conflict.",
            "nullable":true,
            "x-queryable":true
        },
        "FifthTokenName":{
            "title":"Message Token 5 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The fifth token for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstTokenName":{
            "title":"Message Token 1 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The first token for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "FourthTokenName":{
            "title":"Message Token 4 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The fourth token for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondTokenName":{
            "title":"Message Token 2 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The second token for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FirstTokenValue":{
            "title":"Message Token Value 1",
            "maxLength":"80",
            "type":"string",
            "description":"The first token value for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdTokenName":{
            "title":"Message Token 3 Name",
            "maxLength":"30",
            "type":"string",
            "description":"The third token for the message text.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondTokenValue":{
            "title":"Message Token 2 Value",
            "maxLength":"80",
            "type":"string",
            "description":"The second token value for the message text.",
            "nullable":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 : studentAcademicPlans-items-item-response

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  Unique identifier for a curriculum item.
• CurriculumName: string
  Title: Curriculum Name

  Read Only: true

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

  Read Only: true

  Maximum Length: 30

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

  Unique identifier for the type category of a curriculum item.
• ItemId: integer (int64)
  Title: Planned Item ID

  Unique identifier for a plan item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanItemFlag: boolean
  Title: Primary Plan Item

  Maximum Length: 1

  Default Value: false

  Identifies the primary curriculum item for the plan.
• 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 a program type that's associated with a program.
• ProgramTypeName: string
  Title: Program Type

  Read Only: true

  Maximum Length: 50

  The name of a program type that's associated with a program.
• SequenceNumber: integer (int32)
  Title: Plan Item Sequence

  Used to sequence the order of the plan item.

{
    "type":"object",
    "properties":{
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier for a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type that's associated with a program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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":"Unique identifier for the type category of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":"30",
            "type":"string",
            "description":"The curriculum type of the curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanItemFlag":{
            "title":"Primary Plan Item",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies the primary curriculum item for the plan.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Plan Item Sequence",
            "type":"integer",
            "description":"Used to sequence the order of the plan 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"
            }
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "type":"string",
            "description":"The name of a curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeName":{
            "title":"Program Type",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a program type that's associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Planned Item ID",
            "type":"integer",
            "description":"Unique identifier for a plan item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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 : studentAcademicPlans-periods-item-response

Type: object

Show Source

• elements: array Elements
  Title: Elements

  The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the period.
• FormatPeriodId: integer (int64)
  Title: Period ID

  The unique identifier for the associated plan format period.
• FormatPeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  The name of the academic plan format period.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Default Value: false

  Locks the plan period, indicating the period is required.
• ParentFormatPeriodId: integer (int64)
  Title: Parent Format Period ID

  Read Only: true

  The Identifier for the parent format period.
• ParentFormatPeriodName: string
  Title: Parent Format Period Name

  Read Only: true

  Maximum Length: 50

  The name of the parent format period.
• ParentTemplatePeriodId: integer (int64)
  Title: Parent Template Period ID

  Read Only: true

  The Identifier for the parent template period.
• ParentTemplatePeriodName: string
  Title: Parent Template Period Name

  Read Only: true

  Maximum Length: 50

  The name of the parent template period.
• PeriodCourseCountQuantity: integer (int32)
  Title: Period Course Count

  The courses planned for the plan period.
• PeriodInstructions: string
  Title: Period Instructions

  Read Only: true

  The period instructions that convey academic plan requirements to the student or administrator.
• PeriodSequence: integer (int32)
  Title: Period Sequence Number

  Sequence of the plan format period within a level.
• PeriodUnitCountQuantity: number
  Title: Period Unit Count

  The units planned for the plan period.
• PlanPeriodId: integer (int64)
  Title: Plan Period ID

  The unique identifier for the plan period.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Unique identifier for the student academic plan reporting period.
• ReportingPeriodName: string
  Title: Reporting Period Name

  Read Only: true

  Maximum Length: 50

  The name of the reporting period.
• ScheduleEnabledFlag: boolean
  Indicates whether the period can be used to create a scheduler.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the period.
• TemplatePeriodId: integer (int64)
  Title: Template Period ID

  The unique identifier for the academic plan template period record.
• TemplatePeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  The name of the academic plan template period.

{
    "type":"object",
    "properties":{
        "ParentTemplatePeriodName":{
            "title":"Parent Template Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the parent template period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentFormatPeriodName":{
            "title":"Parent Format Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the parent format period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the period can be used to create a scheduler.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReportingPeriodId"
                ]
            },
            "x-queryable":true
        },
        "TemplatePeriodName":{
            "title":"Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the academic plan template period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodCourseCountQuantity":{
            "title":"Period Course Count",
            "type":"integer",
            "description":"The courses planned for the plan period.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PeriodSequence":{
            "title":"Period Sequence Number",
            "type":"integer",
            "description":"Sequence of the plan format period within a level.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ParentFormatPeriodId":{
            "title":"Parent Format Period ID",
            "type":"integer",
            "description":"The Identifier for the parent format period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the period.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormatPeriodId":{
            "title":"Period ID",
            "type":"integer",
            "description":"The unique identifier for the associated plan format period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the reporting period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodUnitCountQuantity":{
            "title":"Period Unit Count",
            "type":"number",
            "description":"The units planned for the plan period.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the period.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodInstructions":{
            "title":"Period Instructions",
            "type":"string",
            "description":"The period instructions that convey academic plan requirements to the student or administrator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplatePeriodId":{
            "title":"Template Period ID",
            "type":"integer",
            "description":"The unique identifier for the academic plan template period record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanPeriodId":{
            "title":"Plan Period ID",
            "type":"integer",
            "description":"The unique identifier for the plan period.",
            "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 periods resource and provides a list of curriculum items associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-periods-elements-item-response"
            }
        },
        "FormatPeriodName":{
            "title":"Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the academic plan format period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentTemplatePeriodId":{
            "title":"Parent Template Period ID",
            "type":"integer",
            "description":"The Identifier for the parent template period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"Unique identifier for the student academic plan reporting period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LockPeriodFlag":{
            "title":"Lock Period",
            "maxLength":"1",
            "type":"boolean",
            "description":"Locks the plan period, indicating the period is required.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Elements

Type: array

Title: Elements

The elements resource is a child of the periods resource and provides a list of curriculum items associated with a student academic plan.

Show Source

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

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

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

  The number of contact hours required for the period element.
• DeleteActionFlag: boolean
  Title: Delete Action

  Indicates whether the delete action for curriculum course element is active or inactive.
• 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.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Default Value: false

  Locks the plan template element, preventing changes or removal of the element.
• MinimumRequiredUnitsQuantity: number
  Title: Minimum Required Units

  The minimum units required for the period element.
• NumberOfUnitsTakenQuantity: number
  Title: Number of Units Taken

  The number of units taken for the period element.
• PeriodElementId: integer (int64)
  Title: Plan Period Element ID

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

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

  The related elements resource is a child of the elements resource and provides a list of related elements associated with a student academic plan.
• SourceCurriculumId: integer (int64)
  Title: Source Curriculum ID

  Unique identifier for the requirement 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

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

  Read Only: true

  Maximum Length: 50

  The curriculum item type name of the requirement source curriculum item.

{
    "type":"object",
    "properties":{
        "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
        },
        "PeriodElementSequence":{
            "title":"Period Element Sequence",
            "type":"integer",
            "description":"The sequence of the plan elements within a plan 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,
            "x-hints":{
                "precision":"11",
                "scale":"2"
            },
            "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":true,
            "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":"Unique identifier for the requirement source curriculum type.",
            "format":"int64",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LockElementFlag":{
            "title":"Lock Element",
            "maxLength":"1",
            "type":"boolean",
            "description":"Locks the plan template element, preventing changes or removal of the element.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PeriodElementId":{
            "title":"Plan Period Element ID",
            "type":"integer",
            "description":"The unique identifier for the plan period element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceCurriculumId":{
            "title":"Source Curriculum ID",
            "type":"integer",
            "description":"Unique identifier for the requirement source curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NumberOfUnitsTakenQuantity":{
            "title":"Number of Units Taken",
            "type":"number",
            "description":"The number of units taken for the period element.",
            "nullable":true,
            "x-hints":{
                "precision":"11",
                "scale":"2"
            },
            "x-queryable":true
        },
        "relatedElements":{
            "title":"Related Elements",
            "type":"array",
            "description":"The related elements resource is a child of the elements resource and provides a list of related elements associated with a student academic plan.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-periods-elements-relatedElements-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 elements resource and provides a list of related elements associated with a student academic plan.

Show Source

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

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

Nested Schema : studentAcademicPlans-periods-elements-relatedElements-item-response

Type: object

Show Source

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

  The curriculum item identifier for 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 plan element relationship unique identifier.
• RelatedCurriculumName: string
  Title: Related Curriculum Name

  Read Only: true

  The curriculum item name of the related curriculum item.
• RelatedCurriculumType: string
  Title: Related Curriculum Type

  Read Only: true

  The curriculum item type of the related curriculum item.
• RelatedCurriculumTypeId: string
  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

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

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

{
    "type":"object",
    "properties":{
        "RelatedCurriculumTypeName":{
            "title":"Related Curriculum Type Name",
            "type":"string",
            "description":"The curriculum item type name of the related curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedCurriculumId":{
            "title":"Related Curriculum ID",
            "type":"integer",
            "description":"The plan element relationship unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ElementRelatedId":{
            "title":"Plan Element Related ID",
            "type":"integer",
            "description":"The curriculum item identifier for the related curriculum item.",
            "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 element and the related item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RelatedCurriculumName":{
            "title":"Related Curriculum Name",
            "type":"string",
            "description":"The curriculum item name of the related curriculum item.",
            "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"
            }
        },
        "RelatedCurriculumTypeId":{
            "title":"Related Curriculum Type ID",
            "type":"string",
            "description":"The curriculum item type identifier for the related curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedCurriculumType":{
            "title":"Related Curriculum Type",
            "type":"string",
            "description":"The curriculum item type of the related curriculum item.",
            "nullable":true,
            "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

conflicts

Operation: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/conflicts

Parameters:

• studentAcademicPlansUniqID: $request.path.studentAcademicPlansUniqID

The conflicts resource is a child of the student academic plans resource and provides a list of conflicts associated with a student academic plan.

items

Operation: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/items

Parameters:

• studentAcademicPlansUniqID: $request.path.studentAcademicPlansUniqID

The items resource is a child of the student academic plans resource and provides a list of curriculum items associated with a student academic plan.

periods

Operation: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods

Parameters:

• studentAcademicPlansUniqID: $request.path.studentAcademicPlansUniqID

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