API Keys

Set the query worker access level

Sets the access level for the query worker in the GeoFabric geofabric for an API key with keyid.

Requires a JSON object with these properties:

grant: Use "rw" to set the query worker level access to Read/Write. Use "ro" to set the query worker level access to Read Only. Use "none" to set the query worker level access to No access.
query worker: Use "*" to set default access level for all query workers.

If access level for a query worker is not set, then the default("*") access level is used. If the default("*") access level is also not set, then the GeoFabric access level is used.

Note: Requires administrator permissions.

put/_api/key/{keyid}/database/{geofabric}/restql/{query-worker}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/key/:keyid/database/:geofabric/restql/:query-worker/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

keyidstring string required

The ID of the API key querying the GeoFabric.

geofabricstring string required

The name of the GeoFabric.

query-workerstring string required

The name of the query worker.

Request body

grantstring required

Use "rw" to set the query worker level access to Read/Write.
Use "ro" to set the query worker level access to Read Only.
Use "none" to set the query worker level access to No access.

Example request

{
  "grant": "rw"
}

Response

Successfully changed access permissions.

unknown required

Example response

{
  "code": 200,
  "error": false,
  "_system/testQueryWorker": "ro"
}

Changes

No recorded changes to this operation across all 1 revision of this API.