Jump to

• Request
• Response

Create all elements

post

/fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements

Request

Path Parameters

• academicPlanTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Academic Plan Templates resource and used to uniquely identify an instance of Academic Plan Templates. The client should not generate the hash key value. Instead, the client should query on the Academic Plan Templates collection resource in order to navigate to a specific instance of Academic Plan Templates to get the hash key.
• periodsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- TemplatePeriodId and TemplateInstructionId ---for the Periods resource and used to uniquely identify an instance of Periods. The client should not generate the hash key value. Instead, the client should query on the Periods collection resource with a filter on the primary key values in order to navigate to a specific instance of Periods.
  
  For example: periods?q=TemplatePeriodId=<value1>;TemplateInstructionId=<value2>

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

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

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

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

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

  Maximum Length: 1

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

  Default Value: 0

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

  Default Value: 0

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

  Default Value: 0

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

  Default Value: 0

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

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

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

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

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

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

  The unique identifier for the template period.

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

Nested Schema : Course Requisites

Type: array

Title: Course Requisites

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

Show Source

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

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

Nested Schema : Related Elements

Type: array

Title: Related Elements

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

Show Source

• Array of: object schema

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

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

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

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

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

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

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

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

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 : academicPlanTemplates-periods-elements-item-response

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

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

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 80

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

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

  Read Only: true

  Maximum Length: 10

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

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

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

  Maximum Length: 1

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

  Default Value: 0

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

  Default Value: 0

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

  Read Only: true

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

  Default Value: 0

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

  Default Value: 0

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

  Read Only: true

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

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

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

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

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

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

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

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

  The unique identifier for the template period.

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

Nested Schema : Course Requisites

Type: array

Title: Course Requisites

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

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Related Elements

Type: array

Title: Related Elements

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

Show Source

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

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

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

Type: object

Show Source

• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 10

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

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

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

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

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

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

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

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

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

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

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

  Read Only: true

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

  Maximum Length: 30

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

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

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

courseRequisites

Operation: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/courseRequisites

Parameters:

• academicPlanTemplatesUniqID: $request.path.academicPlanTemplatesUniqID
• elementsUniqID: $request.path.elementsUniqID
• periodsUniqID: $request.path.periodsUniqID

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

relatedElements

Operation: /fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/periods/{periodsUniqID}/child/elements/{elementsUniqID}/child/relatedElements

Parameters:

• academicPlanTemplatesUniqID: $request.path.academicPlanTemplatesUniqID
• elementsUniqID: $request.path.elementsUniqID
• periodsUniqID: $request.path.periodsUniqID

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

Back to Top