Update a document parameter
patch
/fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/documentParameters/{InstanceParameterId}
Request
Path Parameters
-
DocumentId(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=
-
InstanceParameterId(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
-
ParameterValue: string
Maximum Length:
255
Value of the parameter of the document definition. -
SecondParameterValue: string
Maximum Length:
255
This attribute isn't currently used.
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.
Root Schema : collaborationDocumentDefinitions-documentParameters-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document parameter. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the document parameter. -
InstanceParameterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the instance of the document parameter. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the document parameter. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the document parameter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParameterCode: string
Maximum Length:
100
Abbreviation that identifies the parameter of the document definition. -
ParameterName: string
Read Only:
true
Maximum Length:80
Name of the parameter of the document definition. -
ParameterValue: string
Maximum Length:
255
Value of the parameter of the document definition. -
SecondParameterValue: string
Maximum Length:
255
This attribute isn't currently used.
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.