Jump to

• Request
• Response

Get all periods

get

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

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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all periods that match the primary key criteria specified.
    Finder Variables
    • PlanPeriodId; integer; Unique identifier for the plan period.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EndDate; string; The end date of the period.
  • FormatPeriodId; integer; The unique identifier for the associated plan format period.
  • FormatPeriodName; string; The name of the academic plan format period.
  • LockPeriodFlag; boolean; Locks the plan period, indicating the period is required.
  • ParentFormatPeriodId; integer; The Identifier for the parent format period.
  • ParentFormatPeriodName; string; The name of the parent format period.
  • ParentTemplatePeriodId; integer; The Identifier for the parent template period.
  • ParentTemplatePeriodName; string; The name of the parent template period.
  • PeriodCourseCountQuantity; integer; The courses planned for the plan period.
  • PeriodInstructions; string; The period instructions that convey academic plan requirements to the student or administrator.
  • PeriodSequence; integer; Sequence of the plan format period within a level.
  • PeriodUnitCountQuantity; number; The units planned for the plan period.
  • PlanPeriodId; integer; The unique identifier for the plan period.
  • ReportingPeriodId; integer; Unique identifier for the student academic plan reporting period.
  • ReportingPeriodName; string; The name of the reporting period.
  • ScheduleEnabledFlag; boolean; Indicates whether the period can be used to create a scheduler.
  • StartDate; string; The start date of the period.
  • TemplatePeriodId; integer; The unique identifier for the academic plan template period record.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

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-periods

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/studentAcademicPlans-periods-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/studentAcademicPlans-periods-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-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":{
        "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
        },
        "FormatPeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic plan format period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PeriodUnitCountQuantity":{
            "title":"Period Unit Count",
            "type":"number",
            "description":"The units planned for the plan period.",
            "nullable":true,
            "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
        },
        "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
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting 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
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the period.",
            "format":"date",
            "nullable":false,
            "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
        },
        "TemplatePeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic plan template period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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 : 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-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":{
        "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
        },
        "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
        },
        "RelatedCurriculumName":{
            "title":"Related Curriculum Name",
            "type":"string",
            "description":"The curriculum item name of 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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top