Jump to

• Request
• Response

Update an element

patch

/fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}

Request

Path Parameters

• PlanPeriodId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• elementsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Elements resource and used to uniquely identify an instance of Elements. The client should not generate the hash key value. Instead, the client should query on the Elements collection resource in order to navigate to a specific instance of Elements to get the hash key.
• 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: string
  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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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":{
        "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
            }
        },
        "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
            }
        },
        "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
        },
        "MinimumRequiredUnitsQuantity":{
            "title":"Minimum Required Units",
            "type":"number",
            "description":"The minimum units required for the period element.",
            "nullable":true,
            "x-hints":{
                "precision":11,
                "scale":2
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "SourceCurriculumId":{
            "title":"Source Curriculum ID",
            "type":"integer",
            "description":"Unique identifier for the requirement source curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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":{
        "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"
            }
        },
        "RelatedCurriculumId":{
            "title":"Related Curriculum ID",
            "type":"integer",
            "description":"The plan element relationship unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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-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"
    }
}

Links

relatedElements

Operation: /fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements/{elementsUniqID}/child/relatedElements

Parameters:

• PlanPeriodId: $request.path.PlanPeriodId
• elementsUniqID: $request.path.elementsUniqID
• studentAcademicPlansUniqID: $request.path.studentAcademicPlansUniqID

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

Back to Top