Get a mobile offline control field
get
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields/{publicSectorMobileOfflineControlFieldsUniqID}
Request
Path Parameters
-
publicSectorMobileOfflineControlFieldsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ConfigurationId and MobileApp ---for the Mobile Offline Configurations resource and used to uniquely identify an instance of Mobile Offline Configurations. The client should not generate the hash key value. Instead, the client should query on the Mobile Offline Configurations collection resource with a filter on the primary key values in order to navigate to a specific instance of Mobile Offline Configurations.
For example: publicSectorMobileOfflineControlFields?q=ConfigurationId=<value1>;MobileApp=<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 : publicSectorMobileOfflineControlFields-item-response
Type:
Show Source
object
-
Active: string
Maximum Length:
1
Indicates if the configuration is active or not. -
ConfigurationId: string
Maximum Length:
50
The unique identifier of a configuration. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time when the row was created. -
DeletedFlag: string
Maximum Length:
1
Indicates whether the record has been logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. Default value is N. -
Description: string
Maximum Length:
200
Description of the configuration. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MobileApp: string
Maximum Length:
100
Unique identifier for a configuration and the name of the mobile application to apply. -
ModuleId: string
Maximum Length:
32
Indicates the module that owns the row. A module is an entry in the application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
SeedDataLock: integer
(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.
-
SeedDataSource: string
Maximum Length:
512
Identifies the source of the seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, it specifies the name of the seed data file. -
Unit: string
Maximum Length:
200
Unit to display on mobile pages. -
Value: string
Maximum Length:
200
Stores the configuration value provided by seed data or user.
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.