Location CreationΒΆ
Create the bearer_token and store in a file in a secure local directory with 0600 permissions.
See API Request Authorization and Authentication.
Note
The following example shows use of the API over curl in a bash terminal. The concepts are fully portable to any other REST client (eg PostMan or python requests)
Set the URL (for example):
$ export URL=https://synsation.1234-5678.nodes.archivist.jitsuin.io
Define the location parameters and store in /path/to/jsonfile:
{
"display_name": "Macclesfield, Cheshire",
"description": "Manufacturing site, North West England, Macclesfield, Cheshire",
"latitude": 53.2546799,
"longitude": -2.1213956,
"attributes": {
"director": "John Smith",
"address": "Unit 6A, Synsation Park, Maccelsfield",
"Facility Type": "Manufacture",
"support_email": "support@macclesfield.com",
"support_phone": "123 456 789"
}
}
Note
- display_name
required Friendly name for the location. Displayed in the Archivist GUI.
- description
required Extended information about the location.
- extended_attributes
freeform and can contain any fields.
See Swagger POST API
Create the location to POSTing to the locations
resource:
$ curl -v -X POST \
-H "@$BEARER_TOKEN_FILE" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
$URL/archivist/v2/locations
The response is:
{
"identity": "locations/08838336-c357-460d-902a-3aba9528dd22",
"display_name": "Macclesfield, Cheshire",
"description": "Manufacturing site, North West England, Macclesfield, Cheshire",
"latitude": 53.2546799,
"longitude": -2.1213956,
"attributes": {
"director": "John Smith",
"address": "Bridgewater, Somerset",
"Facility Type": "Manufacture",
"support_email": "support@macclesfield.com",
"support_phone": "123 456 789"
}
}
Note
- identity
used to attach the location to an asset during asset creation or asset event. (usually a maintenance event).