Location Actions
- 03 Jun 2022
- 1 Minute to read
- Print
- DarkLight
Location Actions
- Updated on 03 Jun 2022
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
getLocation
Retrieves just one Location.
Property | Value | Description |
id* | string | The ID of the Location |
location = saveLocation({"name": "Houston", "code": "111"})
location = getLocation(location.id)getAllLocations
Retrieves all Locations.
Property | Value | Description |
pageSize | integer | The page size (required for a paging request) |
pageNum | integer | The page number (defaults to 1 for a paging request) |
saveLocation({"name": "Houston", "code": "111"})
locations = getAllLocations()saveLocation
Updates a Location.
Property | Value | Description |
id* | string | The ID of the Location |
saveLocation({"name": "Houston", "code": "111"})getLocationRelationship
Retrieves just one Location relationship.
Property | Value | Description |
id* | string | The ID of the Location relationship |
location = saveLocation({"name": "Houston", "code": "111"})
locationRel = saveLocationRelationship({"locationId": location.id, "userId":"user_id", "role": "ADMINISTRATOR"})
locationRel = getLocationRelationship(locationRel.id)getAllLocationRelationships
Retrieves all Location Relationships.
Property | Value | Description |
locationId | string | The location ID for which to fetch location relationships |
userId | string | The user ID for which to fetch location relationships |
role | string | The role for which to fetch location relationships |
pageSize | integer | The page size (required for a paging request) |
pageNum | integer | The page number (defaults to 1 for a paging request) |
location = saveLocation({"name": "Houston", "code": "111"})
locationRel = saveLocationRelationship({"locationId": location.id, "userId":"user_id", "role": "ADMINISTRATOR"})
locationRels = getAllLocationRelationships()saveLocationRelationship
Updates a Location Relationship.
Property | Value | Description |
id* | string | The ID of the Location Relationship |
location = saveLocation({"name": "Houston", "code": "111"})
saveLocationRelationship({"locationId": location.id, "userId":"user_id", "role": "ADMINISTRATOR"})deleteLocationRelationship
Deletes a Location Relationship.
Property | Value | Description |
id* | string | The ID of the Location Relationship |
Delete by Location Relationship id.
deleteLocation
Deletes a Location.
Property | Value | Description |
id* | string | The ID of the Location |
Delete by Location id.
Was this article helpful?