Update an application program
patch
/fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationPrograms/{applicationProgramsUniqID}
Request
Path Parameters
-
FormId(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=
-
applicationProgramsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Form Fragments resource and used to uniquely identify an instance of Form Fragments. The client should not generate the hash key value. Instead, the client should query on the Form Fragments collection resource in order to navigate to a specific instance of Form Fragments 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
-
CourseSelectorFlag: boolean
Title:
Course Selector
Maximum Length:1
Default Value:false
Indicates if the course selector is used for this program. -
FormApplicationProgId: integer
(int64)
Title:
Form Application Program ID
Form admissions application program identifier. -
ProgramItemCurriculumId: integer
(int64)
Title:
Program Item Curriculum ID
Curriculum item identifier for the program.
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 : applicationFormDefinitions-applicationPrograms-item-response
Type:
Show Source
object
-
CourseSelectorFlag: boolean
Title:
Course Selector
Maximum Length:1
Default Value:false
Indicates if the course selector is used for this program. -
FormApplicationProgId: integer
(int64)
Title:
Form Application Program ID
Form admissions application program identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramItemCurriculumId: integer
(int64)
Title:
Program Item Curriculum ID
Curriculum item identifier for the program. -
ProgramName: string
Title:
Program
Read Only:true
Name of the curriculum program.
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.
Links
- ProgramLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/programsThe following properties are defined on the LOV link relation:
- Source Attribute: ProgramItemCurriculumId; Target Attribute: CurriculumId
- Display Attribute: CurriculumName