Create a set of transaction types for a terms of use definition
post
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage
Request
Path Parameters
-
publicSectorTermsOfUsesUniqID(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 Definitions resource and used to uniquely identify an instance of Terms Of Use Definitions. The client should not generate the hash key value. Instead, the client should query on the Terms Of Use Definitions collection resource with a filter on the primary key values in order to navigate to a specific instance of Terms Of Use Definitions.
For example: publicSectorTermsOfUses?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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for an agency that is associated with a terms of use definition.
-
EffectiveEndDate: string
(date)
The effective end date of the terms of use definition.
-
EffectiveStartDate: string
(date)
The effective start date of the terms of use definition.
-
EnabledFlag: string
Maximum Length:
1
Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N. -
Product: string
Maximum Length:
30
The transaction type for which the terms content is enabled or disabled. -
TermsUseId: string
Maximum Length:
15
The unique identifier for a terms of use definition.
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 : publicSectorTermsOfUses-TermsUsage-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for an agency that is associated with a terms of use definition.
-
Description: string
Title:
Description
Read Only:true
Maximum Length:100
The description of the terms of use definition. -
EffectiveEndDate: string
(date)
The effective end date of the terms of use definition.
-
EffectiveStartDate: string
(date)
The effective start date of the terms of use definition.
-
EnabledFlag: string
Maximum Length:
1
Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Product: string
Maximum Length:
30
The transaction type for which the terms content is enabled or disabled. -
TermsUseId: string
Maximum Length:
15
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.