Jump to

• Request
• Response

Update a mobile offline control field

patch

/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>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Active: string
  Maximum Length: 1

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

  The unique identifier of a configuration.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "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.",
            "nullable":true
        },
        "Active":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the configuration is active or not.",
            "nullable":false
        },
        "Description":{
            "maxLength":"200",
            "type":"string",
            "description":"Description of the configuration.",
            "nullable":false
        },
        "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.",
            "nullable":true
        },
        "MobileApp":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique identifier for a configuration and the name of the mobile application to apply.",
            "nullable":false
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "Value":{
            "maxLength":"200",
            "type":"string",
            "description":"Stores the configuration value provided by seed data or user.",
            "nullable":false
        },
        "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.",
            "nullable":true
        },
        "Unit":{
            "maxLength":"200",
            "type":"string",
            "description":"Unit to display on mobile pages.",
            "nullable":true
        },
        "ConfigurationId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of a configuration.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorMobileOfflineControlFields-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"200",
            "type":"string",
            "description":"Description of the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "Unit":{
            "maxLength":"200",
            "type":"string",
            "description":"Unit to display on mobile pages.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfigurationId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of a configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "Active":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the configuration is active or not.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MobileApp":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique identifier for a configuration and the name of the mobile application to apply.",
            "nullable":false,
            "x-queryable":true
        },
        "Value":{
            "maxLength":"200",
            "type":"string",
            "description":"Stores the configuration value provided by seed data or user.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top