Skip to content
getgeolens.com

Set Dataset Groups Endpoint

PUT
/datasets/{dataset_id}/groups/
curl --request PUT \
--url https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/groups/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "group_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Share a dataset with exactly these sharing groups (owner or admin).

An owner may add only groups they belong to (403); an admin may add any. A private dataset shared with a group becomes restricted, and a restricted one left with no group or role grant becomes private; internal and public datasets keep their audience. 404 for an unknown group, and 422 when the change would hide the dataset from viewers of the owner’s shared maps or let a VRT reach people who cannot see all of its sources.

dataset_id
required
Dataset Id
string format: uuid
Media type application/json
DatasetGroupsUpdate
object
group_ids
required
Group Ids

Every group the dataset is shared with afterwards; an empty list unshares it. An owner may add only groups they belong to, and an admin any group.

Array<string>
<= 100 items

Example generated

{
"group_ids": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
]
}

Successful Response

Media type application/json
DatasetGroupsResponse
object
visibility
required
Visibility

The dataset’s visibility after the change: a private dataset shared with a group becomes restricted, and a restricted one left with no group or role grant becomes private.

string
groups
required
Groups

The sharing groups the dataset is shared with, by name.

Array<object>
GroupRef
object
id
required
Id

Unique group identifier.

string format: uuid
name
required
Name

Group name.

string
metadata_warnings
Any of:
Array<string>

Example generated

{
"visibility": "example",
"groups": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example"
}
],
"metadata_warnings": [
"example"
]
}

Bad request — invalid payload

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}

Forbidden — caller lacks access to this resource

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}

Not found

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}

Conflict — resource state prevents the operation

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}

Validation error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}
Retry-After
integer

Seconds until the request may be retried

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example

{
"detail": "Dataset not found",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}