Update a checkpoint data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData/{CheckpointId}
Request
Path Parameters
-
CheckpointId(required): integer(int64)
The unique identifier of the checkpoint.
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
-
CheckpointData: string
(byte)
The checkpoint data.
-
CreatedByUser: string
Maximum Length:
10
The name of the user who created the checkpoint data. -
InterviewName: string
Maximum Length:
150
The name of the interview that is associated with the checkpoint data. -
InterviewVersion: string
Maximum Length:
20
The version of the interview that is associated with the checkpoint data. -
ProviderId: string
Maximum Length:
200
The unique identifier of the provider associated with the checkpoint data.
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 : publicSectorOpaCheckPointData-item-response
Type:
Show Source
object
-
CheckpointData: string
(byte)
The checkpoint data.
-
CheckpointId: integer
(int64)
Read Only:
true
The unique identifier of the checkpoint. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who created the checkpoint data. -
CreatedByUser: string
Maximum Length:
10
The name of the user who created the checkpoint data. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the checkpoint data was created. -
InterviewName: string
Maximum Length:
150
The name of the interview that is associated with the checkpoint data. -
InterviewVersion: string
Maximum Length:
20
The version of the interview that is associated with the checkpoint data. -
LastUpdateDate: string
(date-time)
Read Only:
true
The name of the user who last updated the checkpoint data. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The date on which the checkpoint data was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProviderId: string
Maximum Length:
200
The unique identifier of the provider associated with the checkpoint data.
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.