The resource Groundworks has the following endpoints:

GET /api/v1/groundworks/{gipodId}

Description

Get details of a Groundwork for a given GIPOD ID.

Resource URL

GET /api/v1/groundworks/{gipodId} (Swagger)

Scopes

TBD

Example(s)

TBD

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

GET /api/v1/groundworks/{gipodId}/occurrences

Description

Get the periods of a Groundwork for a given GIPOD ID.

Resource URL

GET /api/v1/groundworks/{gipodId}/occurrences (Swagger)

Scopes

TBD

Example(s)

TBD

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

GET /api/v1/groundworks/{gipodId}/contactorganisations/{contactId}

Description

Get contact information of a Groundwork for a given GIPOD ID and contact ID.

Resource URL

GET /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} (Swagger)

Scopes

TBD

Example(s)

TBD

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

GET /api/v1/groundworks/{gipodId}/zones/{zoneId}

Description

Get the zone details of a Groundwork for a given GIPOD ID and zone ID.

Resource URL

GET /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)

Scopes

TBD

Example(s)

TBD

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

PATCH /api/v1/groundworks/{gipodId}

Description

Partial modifications of a groundwork are possible. Supported modifications are indicated in the request sample.

Resource URL

PATCH /api/v1/groundworks/{gipodId} (Swagger)

Scopes

TBD

Example(s)

TBD

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

POST /api/v1/groundworks

Description

Register a new Groundwork.

Resource URL

POST /api/v1/groundworks

Scopes

gipod_pdo

Examples

You want to register a Groundwork ...

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

You want to register a Groundwork ...

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

You want to register a Groundwork ...

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

PUT /api/v1/groundworks/{gipodId}/zones/{zoneId}

Description

Modify a zone.

Resource URL

PUT /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger link TBD)

Scopes

TBD

Example(s)

TBD

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}