Update an Instructional text
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInstructionalTexts/{publicSectorInstructionalTextsUniqID}
Request
Path Parameters
-
publicSectorInstructionalTextsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, TextId, EffectiveStartDate and EffectiveEndDate ---for the Instructional Texts resource and used to uniquely identify an instance of Instructional Texts. The client should not generate the hash key value. Instead, the client should query on the Instructional Texts collection resource with a filter on the primary key values in order to navigate to a specific instance of Instructional Texts.
For example: publicSectorInstructionalTexts?q=AgencyId=<value1>;TextId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
Category: string
Title:
Category
Maximum Length:30
The category of the instructional text. -
Description: string
Maximum Length:
200
The long description of the instructional text. -
EffectiveEndDate: string
(date)
The date at the end of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
The date at the beginning of the date range within which the row is effective.
-
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the instructional text is enabled or not. -
TextContent: string
(byte)
Title:
Content
The content of the instructional text. -
TextName: string
Title:
Text Name
Maximum Length:100
The short description of the instructional text.
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 : publicSectorInstructionalTexts-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
Category: string
Title:
Category
Maximum Length:30
The category of the instructional text. -
Description: string
Maximum Length:
200
The long description of the instructional text. -
EffectiveEndDate: string
(date)
The date at the end of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
The date at the beginning of the date range within which the row is effective.
-
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the instructional text is enabled or not. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TextContent: string
(byte)
Title:
Content
The content of the instructional text. -
TextId: string
Title:
Text ID
Maximum Length:50
The unique value that identifies an instructional text. -
TextName: string
Title:
Text Name
Maximum Length:100
The short description of the instructional text.
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.