Jump to

• Request
• Response

Get all mobile offline control fields

get

/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineControlFields

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds mobile offline control fields by the primary key. Finder Variables:
    • ConfigurationId; string; Unique identifier for a mobile transaction.
    • MobileApp; string; Unique identifier for a mobile application.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorMobileOfflineControlFields

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorMobileOfflineControlFields-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorMobileOfflineControlFields-item

{
    "items":{
        "$ref":"#/definitions/publicSectorMobileOfflineControlFields-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorMobileOfflineControlFields-item

Type: object

Show Source

• Active(optional): string
  Maximum Length: 1

  Indicates if the configuration is active or not.
• ConfigurationId(optional): string
  Maximum Length: 50

  The unique identifier of a configuration.
• CreatedBy(optional): string
  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate(optional): string(date-time)
  Indicates the date and time when the row was created.
• DeletedFlag(optional): 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(optional): string
  Maximum Length: 200

  Description of the configuration.
• LastUpdateDate(optional): string(date-time)
  Indicates the date and time of the last update of the row.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  Indicates the session login associated to the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• MobileApp(optional): string
  Maximum Length: 100

  Unique identifier for a configuration and the name of the mobile application to apply.
• ModuleId(optional): 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(optional): integer(int32)
  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(optional): 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(optional): 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(optional): string
  Maximum Length: 200

  Unit to display on mobile pages.
• Value(optional): string
  Maximum Length: 200

  Stores the configuration value provided by seed data or user.

{
    "properties":{
        "Active":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the configuration is active or not."
        },
        "ConfigurationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of a configuration."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"Indicates the date and time when the row was created."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":200,
            "type":"string",
            "description":"Description of the configuration."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"Indicates the date and time of the last update of the row."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row."
        },
        "MobileApp":{
            "maxLength":100,
            "type":"string",
            "description":"Unique identifier for a configuration and the name of the mobile application to apply."
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"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":{
            "format":"int32",
            "type":"integer",
            "description":"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":{
            "format":"int32",
            "type":"integer",
            "description":"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":{
            "maxLength":512,
            "type":"string",
            "description":"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":{
            "maxLength":200,
            "type":"string",
            "description":"Unit to display on mobile pages."
        },
        "Value":{
            "maxLength":200,
            "type":"string",
            "description":"Stores the configuration value provided by seed data or user."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top