Jump to

• Request
• Response

Update an item

patch

/fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/items/{itemsUniqID}

Request

Path Parameters

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

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

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

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

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

  Maximum Length: 1

  Default Value: false

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

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

  Used to sequence the order of the plan item.

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

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-items-item-response

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 30

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

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

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

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

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 30

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

  The unique identifier for a program type that's associated with a program.
• ProgramTypeName: string
  Title: Program Type

  Read Only: true

  Maximum Length: 50

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

  Used to sequence the order of the plan item.

{
    "type":"object",
    "properties":{
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier for a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type that's associated with a program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeCode":{
            "title":"Program Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The program type code indicating the type of program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"Unique identifier for the type category of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":"30",
            "type":"string",
            "description":"The curriculum type of the curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanItemFlag":{
            "title":"Primary Plan Item",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies the primary curriculum item for the plan.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Plan Item Sequence",
            "type":"integer",
            "description":"Used to sequence the order of the plan item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "type":"string",
            "description":"The name of a curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeName":{
            "title":"Program Type",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a program type that's associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Planned Item ID",
            "type":"integer",
            "description":"Unique identifier for a plan item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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."
        }
    }
}

Back to Top