Update an agency feature
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyFeatures/{publicSectorAgencyFeaturesUniqID}
Request
Path Parameters
-
publicSectorAgencyFeaturesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and FeatureCode ---for the Agency Features resource and used to uniquely identify an instance of Agency Features. The client should not generate the hash key value. Instead, the client should query on the Agency Features collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Features.
For example: publicSectorAgencyFeatures?q=AgencyId=<value1>;FeatureCode=<value2>
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
-
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
Identifies whether the feature is enabled for the agency.
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 : publicSectorAgencyFeatures-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for an agency. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
Identifies whether the feature is enabled for the agency. -
FeatureCode: string
Title:
Feature Code
Maximum Length:160
The unique identifier for a feature. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferingId: string
Maximum Length:
160
The code of the FSM offering, functional area, or feature.
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.