Update a terms of use definition is not supported
patch
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesKeys/{publicSectorTermsOfUsesKeysUniqID}
Request
Path Parameters
-
publicSectorTermsOfUsesKeysUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, TermsUseId, EffectiveStartDate and EffectiveEndDate ---for the Terms Of Use Keys resource and used to uniquely identify an instance of Terms Of Use Keys. The client should not generate the hash key value. Instead, the client should query on the Terms Of Use Keys collection resource with a filter on the primary key values in order to navigate to a specific instance of Terms Of Use Keys.
For example: publicSectorTermsOfUsesKeys?q=AgencyId=<value1>;TermsUseId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>
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
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 : publicSectorTermsOfUsesKeys-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
Default Value:1
The unique identifier for an agency that is associated with a terms of use definition. -
Description: string
Read Only:
true
Maximum Length:100
The description of the terms of use definition. -
EffectiveEndDate: string
(date)
Read Only:
true
The effective end date of a terms of use definition. -
EffectiveStartDate: string
(date)
Read Only:
true
The effective start date of a terms of use definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TermsUseId: string
Read Only:
true
Maximum Length:255
The unique identifier for a terms of use definition.
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.