Update a configuration field
patch
/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}
Request
Path Parameters
-
ScopeConfigId(required): string
The unique identifier of the scope configuration setup.
-
ScopeConfigurationFieldUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ScopeConfigId and ScopeFieldId ---for the Scope Configuration Fields resource and used to uniquely identify an instance of Scope Configuration Fields. The client should not generate the hash key value. Instead, the client should query on the Scope Configuration Fields collection resource with a filter on the primary key values in order to navigate to a specific instance of Scope Configuration Fields.
For example: ScopeConfigurationField?q=ScopeConfigId=<value1>;ScopeFieldId=<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
-
AltKeyAttrb: string
Title:
Alternate Key Field
Maximum Length:100
The alternative unique identifier of the scope configuration setup data. -
AltKeyReference: string
Title:
Reference Business Object
Maximum Length:50
The name of the reference attribute for the alternate attribute in the scope configuration field setup data. -
AutoKeyFlag: boolean
Title:
Surrogate Field
Maximum Length:1
The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates the deleted status of the scope configuration field setup. -
FieldLabelString: string
Title:
Label String Key
Maximum Length:160
The attribute label string that is displayed on the Scope Selection page. -
FieldName: string
Title:
Field Name
Maximum Length:100
The attribute name of the scope configuration field setup data. -
FieldType: string
Title:
Field Type
Maximum Length:20
The attribute type of the scope configuration field setup data. -
ReturnToFsmFlag: boolean
Title:
Return to Functional Setup Manager
Maximum Length:1
The attribute to determine whether the field value is used as a scope for data filtration. -
ScopeConfigId: string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeFieldId: string
Title:
Field ID
Maximum Length:12
The unique identifier of the scope configuration field setup. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the seed data lock status of the scope configuration setup.
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 : publicSectorScopeConfigurations-ScopeConfigurationField-item-response
Type:
Show Source
object
-
AltKeyAttrb: string
Title:
Alternate Key Field
Maximum Length:100
The alternative unique identifier of the scope configuration setup data. -
AltKeyReference: string
Title:
Reference Business Object
Maximum Length:50
The name of the reference attribute for the alternate attribute in the scope configuration field setup data. -
AutoKeyFlag: boolean
Title:
Surrogate Field
Maximum Length:1
The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates the deleted status of the scope configuration field setup. -
FieldLabelString: string
Title:
Label String Key
Maximum Length:160
The attribute label string that is displayed on the Scope Selection page. -
FieldName: string
Title:
Field Name
Maximum Length:100
The attribute name of the scope configuration field setup data. -
FieldType: string
Title:
Field Type
Maximum Length:20
The attribute type of the scope configuration field setup data. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReturnToFsmFlag: boolean
Title:
Return to Functional Setup Manager
Maximum Length:1
The attribute to determine whether the field value is used as a scope for data filtration. -
ScopeConfigId: string
Title:
Scope Configuration ID
Maximum Length:50
The unique identifier of the scope configuration setup. -
ScopeFieldId: string
Title:
Field ID
Maximum Length:12
The unique identifier of the scope configuration field setup. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the seed data lock status of the scope configuration setup.
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.