Skip to content
getgeolens.com
GeoLens Docs

Update Distribution Endpoint

PATCH
/records/{record_id}/distributions/{distribution_id}/
 
curl --request PATCH \
  --url https://example.com/records/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/distributions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "distribution_type": "example", "format": "example", "url": "example", "title": "example", "description": "example", "protocol": "example", "media_type": "example", "is_primary": true }'

Update a distribution (manual only; auto-generated distributions are immutable).

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
record_id
required
Record Id
string format: uuid
distribution_id
required
Distribution Id
string format: uuid

Request Body required

Section titled “ Request Body required ”
Media type application/json
DistributionUpdate
object
distribution_type
Any of:
string
<= 30 characters
format
Any of:
string
<= 50 characters
url
Any of:
string
<= 2048 characters
title
Any of:
string
<= 500 characters
description
Any of:
string
<= 2000 characters
protocol
Any of:
string
<= 100 characters
media_type
Any of:
string
<= 100 characters
is_primary
Any of:
boolean
Example generated 
{
  "distribution_type": "example",
  "format": "example",
  "url": "example",
  "title": "example",
  "description": "example",
  "protocol": "example",
  "media_type": "example",
  "is_primary": true
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
DistributionResponse
object
id
required
Id
string format: uuid
record_id
required
Record Id
string format: uuid
distribution_type
required
Distribution Type
string
format
required
Any of:
string
url
required
Url
string
title
required
Any of:
string
description
required
Any of:
string
protocol
required
Any of:
string
media_type
required
Any of:
string
is_primary
required
Is Primary
boolean
auto_generated
required
Auto Generated

True if created automatically by the system

boolean
Example generated 
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "record_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "distribution_type": "example",
  "format": "example",
  "url": "example",
  "title": "example",
  "description": "example",
  "protocol": "example",
  "media_type": "example",
  "is_primary": true,
  "auto_generated": true
}

400

Section titled “ 400 ”

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"
}

401

Section titled “ 401 ”

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"
}

403

Section titled “ 403 ”

Forbidden — caller lacks write access

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"
}

404

Section titled “ 404 ”

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"
}

409

Section titled “ 409 ”

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"
}

422

Section titled “ 422 ”

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"
}

429

Section titled “ 429 ”

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"
}

Headers

Section titled “ Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “ 500 ”

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"
}

503

Section titled “ 503 ”

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"
}
Privacy Apache 2.0 getgeolens.com