Skip to main content
Skip table of contents

Request samples

Tools

CURL calls

Call

Comment

Call

Comment

curl --location --request GET 'https://localhost:8087/api/v1.0/infrastructure/locations'
--header 'Authorization: Basic YWRtaW46YWRtaW4='

For every call to the API using Basic Authentication, user and password need to be provided in the header.

In the request headers, you will see that the authorization header is going to pass the API a Base64 encoded string representing your username and password values, appended to the text "Basic ".

curl --location --request POST 'https://localhost:8087/api/v1.0/auth/login'
--header 'Content-Type: application/json'
--data-raw '{
"username": "MyUser",
"password": "MyPassword",
"forceIntegratedAuthentication": false
}'

POST Makes a login call, this will return a token for JWT authentication

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags'
--header 'Authorization: Bearer {token}'

GET Get all tags using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10'
--header 'Authorization: Bearer {token}'

GET Get all tags with pagination using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10&Filter=Name@=Uni'
--header 'Authorization: Bearer {token}'

GET Get all tags with pagination and filtering using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10&Filter=Name@=Uni&Sort=Id'
--header 'Authorization: Bearer {token}'

GET Get all tags with pagination, filtering and sorting using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10&Filter=Name@=Uni&Sort=Id&Fields=Id,Name'
--header 'Authorization: Bearer {token}'

GET Get all tags with pagination, filtering, sorting and field selection using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client

curl --location --request POST 'https://localhost:8087/api/v1.0/infrastructure/locations/' --header 'Authorization: Bearer {token}'
--header 'Content-Type: application/json'
--data-raw ' {
"Name":"New Created Location",
"Street":"New Street",
"PostalCode":"NewZipCode",
"City":"New City",
"Country":"New Country",
"Description":"My Description",
"Url":"location.com",
"ExternalRef":"New External Ref"
}'

POST Creates a new location using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

curl --location --request PATCH 'https://localhost:8087/api/v1.0/infrastructure/locations/6' --header 'Authorization: Bearer {token}'
--header 'Content-Type: application/json'
--data-raw '[
{
"op": "replace",
"path": "/Street",
"value": "Ritterstr. 12-14 Patched"
},
{
"op": "replace",
"path": "/Name",
"value": "Universit├Ąt Patched"
}
]'

PATCH Partially updates a location changing street and name using JSON Patch in the body. Uses JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

curl --location --request PUT 'https://localhost:8087/api/v1.0/infrastructure/locations/6' --header 'Authorization: Bearer {token}'
--header 'Content-Type: application/json'
--data-raw ' {
"Id":6,
"Name":"New Name",
"Street":"New Street",
"PostalCode":"NewZipCode",
"City":"New City",
"Country":"New Country",
"Description":"My Description",
"Url":"location.com",
"ExternalRef":"New External Ref"
}'

PUT Updates a location changing the whole entity using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

curl --location --request DELETE 'https://localhost:8087/api/v1.0/infrastructure/rooms/269'
--header 'Authorization: Bearer {token}'

DEL Deletes a room using JWT or API Key token. Replace {token} for the actual token previously generated using a login call or an API Key generated in Pathfinder Client.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.