Update a business location
patch
/fscmRestApi/resources/11.13.18.05/publicSectorBusLocationStatuses/{publicSectorBusLocationStatusesUniqID}
Request
Path Parameters
-
publicSectorBusLocationStatusesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BusinessLocationKey and BusinessLocationId ---for the Bus Location Statuses resource and used to uniquely identify an instance of Bus Location Statuses. The client should not generate the hash key value. Instead, the client should query on the Bus Location Statuses collection resource with a filter on the primary key values in order to navigate to a specific instance of Bus Location Statuses.
For example: publicSectorBusLocationStatuses?q=BusinessLocationKey=<value1>;BusinessLocationId=<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
-
Status: string
Maximum Length:
20
Current status of the location.
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 : publicSectorBusLocationStatuses-item-response
Type:
Show Source
object
-
BusinessEntityId: string
Read Only:
true
Maximum Length:50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business entity. -
BusinessLocationId: string
Read Only:
true
Maximum Length:50
The unique identifier for a business location. -
BusinessLocationKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business location. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Status: string
Maximum Length:
20
Current status of the location.
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.