Update an external subject
patch
/fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjects/{ExternalSubjectId}
Request
Path Parameters
-
ExternalSubjectId(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=
-
PartyId(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=
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
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the course is active or inactive. -
Description: string
Description for the external subject.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
SubjectCode: string
Maximum Length:
50
Alternate unique identifier for the external subject defined for an external organization. -
SubjectName: string
Maximum Length:
50
The name for the external subject.
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 : externalOrganizations-externalSubjects-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the course is active or inactive. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who first created the row for the identifier. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the creation of the row for the identifier. -
Description: string
Description for the external subject.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row for the identifier was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row for the identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubjectCode: string
Maximum Length:
50
Alternate unique identifier for the external subject defined for an external organization. -
SubjectName: string
Maximum Length:
50
The name for the external subject.
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.