Get a scope configuration field
get
/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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.