Update an instruction
patch
/fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/instructions/{TemplateInstructionId}
Request
Path Parameters
-
TemplateInstructionId(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=
-
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.
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
Root Schema : schema
Type:
Show Source
object
-
InstructionContextCode: string
Title:
Instruction Context Code
Maximum Length:30
Identifies the context of the instructions. -
InstructionOwnerId: integer
(int64)
Title:
Instruction Owner ID
The unique identifier for the instructions owner that's associated with the instructions. -
TemplateInstructionId: integer
(int64)
Title:
Template Instruction ID
The unique identifier for the template instructions associated with the academic plan template. -
TemplateInstructions: string
The template instructions that convey academic plan requirements to the student or administrator.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : academicPlanTemplates-instructions-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row with the instructions. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row with the instructions. -
InstructionContextCode: string
Title:
Instruction Context Code
Maximum Length:30
Identifies the context of the instructions. -
InstructionOwnerId: integer
(int64)
Title:
Instruction Owner ID
The unique identifier for the instructions owner that's associated with the instructions. -
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 with the instructions. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row with the instructions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodName: string
Title:
Period Name
Read Only:true
Maximum Length:50
The name of the period associated with the instructions. -
TemplateInstructionId: integer
(int64)
Title:
Template Instruction ID
The unique identifier for the template instructions associated with the academic plan template. -
TemplateInstructions: string
The template instructions that convey academic plan requirements to the student or administrator.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.