Isogeo API v1 API Reference

undefined

API Endpoint
https://v1.api.isogeo.com
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: http, https
Version: 2.20.2.601

Authentication

groupApplication

flow
application
scopes
read-only

Read only access to the API

tokenUrl
https://id.api.qa.isogeo.com/oauth/token
type
oauth2

userApplication

authorizationUrl
https://id.api.qa.isogeo.com/oauth/authorize
flow
accessCode
tokenUrl
https://id.api.qa.isogeo.com/oauth/token
type
oauth2

application

Returns the applications accessible to the current user

GET /applications

Returns the applications accessible to the current user

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "canHaveManyGroups": "boolean",
    "client_id": "string",
    "client_secret": "string",
    "groups": [
      {
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "areKeywordsRestricted": "boolean",
        "canCreateMetadata": "boolean",
        "code": "string",
        "contact": {
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "available": "string",
          "city": "string",
          "count": "integer (int32)",
          "countryCode": "string",
          "email": "string",
          "fax": "string",
          "hash": "string",
          "name": "string",
          "organization": "string",
          "phone": "string",
          "type": "string",
          "zipCode": "string"
        },
        "keywordsCasing": "string",
        "metadataLanguage": "string",
        "themeColor": "string"
      }
    ],
    "kind": "string",
    "name": "string",
    "redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "staff": "boolean",
    "url": "string"
  }
]

Creates a new application

POST /applications

Creates a new application

undefined

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "canHaveManyGroups": "boolean",
  "client_id": "string",
  "client_secret": "string",
  "groups": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  ],
  "kind": "string",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "staff": "boolean",
  "url": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "canHaveManyGroups": "boolean",
  "client_id": "string",
  "client_secret": "string",
  "groups": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  ],
  "kind": "string",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "staff": "boolean",
  "url": "string"
}

Gets the groups associated with an application

GET /applications/{aid}/groups

Gets the groups associated with an application

aid: string (uuid)
in path

The identifier of the application

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
]

Removes the association between the specified group and the specified application

DELETE /applications/{aid}/groups/{gid}

Removes the association between the specified group and the specified application

aid: string (uuid)
in path

The identifier of the application

gid: string (uuid)
in path

The identifier of the workgroup

200 OK

OK

Associates the specified group with the specified application

PUT /applications/{aid}/groups/{gid}

Associates the specified group with the specified application

aid: string (uuid)
in path

The identifier of the application

gid: string (uuid)
in path

The identifier of the workgroup

200 OK

OK

Refreshes the id and the secret of the specified application

POST /applications/{aid}/refresh-oauth2

Refreshes the id and the secret of the specified application

aid: string (uuid)
in path

The identifier of the application

200 OK

OK

Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "canHaveManyGroups": "boolean",
    "client_id": "string",
    "client_secret": "string",
    "groups": [
      {
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "areKeywordsRestricted": "boolean",
        "canCreateMetadata": "boolean",
        "code": "string",
        "contact": {
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "available": "string",
          "city": "string",
          "count": "integer (int32)",
          "countryCode": "string",
          "email": "string",
          "fax": "string",
          "hash": "string",
          "name": "string",
          "organization": "string",
          "phone": "string",
          "type": "string",
          "zipCode": "string"
        },
        "keywordsCasing": "string",
        "metadataLanguage": "string",
        "themeColor": "string"
      }
    ],
    "kind": "string",
    "name": "string",
    "redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "staff": "boolean",
    "url": "string"
  }
]

Deletes an application

DELETE /applications/{id}

Deletes an application

id: string (uuid)
in path

The identifier of the application

200 OK

OK

Returns an application

GET /applications/{id}

Returns an application

id: string (uuid)
in path

The identifier of the resource

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "canHaveManyGroups": "boolean",
  "client_id": "string",
  "client_secret": "string",
  "groups": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  ],
  "kind": "string",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "staff": "boolean",
  "url": "string"
}

Modifies an application

PUT /applications/{id}

Modifies an application

undefined

id: string (uuid)
in path

The identifier of the resource

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "canHaveManyGroups": "boolean",
  "client_id": "string",
  "client_secret": "string",
  "groups": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  ],
  "kind": "string",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "staff": "boolean",
  "url": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "canHaveManyGroups": "boolean",
  "client_id": "string",
  "client_secret": "string",
  "groups": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  ],
  "kind": "string",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "staff": "boolean",
  "url": "string"
}

Removes the association between the specified group and the specified application

DELETE /groups/{gid}/application/{aid}

Removes the association between the specified group and the specified application

gid: string (uuid)
in path

The identifier of the workgroup

aid: string (uuid)
in path

The identifier of the application

200 OK

OK

Associates the specified group with the specified application

PUT /groups/{gid}/application/{aid}

Associates the specified group with the specified application

gid: string (uuid)
in path

The identifier of the workgroup

aid: string (uuid)
in path

The identifier of the application

200 OK

OK

Gets the applications associated with a group

GET /groups/{gid}/applications

Gets the applications associated with a group

gid: string (uuid)
in path

The identifier of the group

200 OK

OK

Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "canHaveManyGroups": "boolean",
    "client_id": "string",
    "client_secret": "string",
    "groups": [
      {
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "areKeywordsRestricted": "boolean",
        "canCreateMetadata": "boolean",
        "code": "string",
        "contact": {
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "available": "string",
          "city": "string",
          "count": "integer (int32)",
          "countryCode": "string",
          "email": "string",
          "fax": "string",
          "hash": "string",
          "name": "string",
          "organization": "string",
          "phone": "string",
          "type": "string",
          "zipCode": "string"
        },
        "keywordsCasing": "string",
        "metadataLanguage": "string",
        "themeColor": "string"
      }
    ],
    "kind": "string",
    "name": "string",
    "redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "staff": "boolean",
    "url": "string"
  }
]

workgroup

Gets the groups associated with an application

GET /applications/{aid}/groups

Gets the groups associated with an application

aid: string (uuid)
in path

The identifier of the application

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
]

Removes the association between the specified group and the specified application

DELETE /applications/{aid}/groups/{gid}

Removes the association between the specified group and the specified application

aid: string (uuid)
in path

The identifier of the application

gid: string (uuid)
in path

The identifier of the workgroup

200 OK

OK

Associates the specified group with the specified application

PUT /applications/{aid}/groups/{gid}

Associates the specified group with the specified application

aid: string (uuid)
in path

The identifier of the application

gid: string (uuid)
in path

The identifier of the workgroup

200 OK

OK

Removes the association between the specified group and the specified application

DELETE /groups/{gid}/application/{aid}

Removes the association between the specified group and the specified application

gid: string (uuid)
in path

The identifier of the workgroup

aid: string (uuid)
in path

The identifier of the application

200 OK

OK

Associates the specified group with the specified application

PUT /groups/{gid}/application/{aid}

Associates the specified group with the specified application

gid: string (uuid)
in path

The identifier of the workgroup

aid: string (uuid)
in path

The identifier of the application

200 OK

OK

Gets the applications associated with a group

GET /groups/{gid}/applications

Gets the applications associated with a group

gid: string (uuid)
in path

The identifier of the group

200 OK

OK

Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "canHaveManyGroups": "boolean",
    "client_id": "string",
    "client_secret": "string",
    "groups": [
      {
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "areKeywordsRestricted": "boolean",
        "canCreateMetadata": "boolean",
        "code": "string",
        "contact": {
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "available": "string",
          "city": "string",
          "count": "integer (int32)",
          "countryCode": "string",
          "email": "string",
          "fax": "string",
          "hash": "string",
          "name": "string",
          "organization": "string",
          "phone": "string",
          "type": "string",
          "zipCode": "string"
        },
        "keywordsCasing": "string",
        "metadataLanguage": "string",
        "themeColor": "string"
      }
    ],
    "kind": "string",
    "name": "string",
    "redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "staff": "boolean",
    "url": "string"
  }
]

Gets the catalogs associated with a group

GET /groups/{gid}/catalogs

Gets the catalogs of a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "$scan": "boolean",
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "_tag": "string",
    "code": "string",
    "count": "integer (int32)",
    "name": "string",
    "owner": {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  }
]

Creates a new catalog

POST /groups/{gid}/catalogs

Creates a new catalog

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "$scan": "boolean",
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}
200 OK

OK

Response Example (200 OK)
{
  "$scan": "boolean",
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}

Deletes a catalog

DELETE /groups/{gid}/catalogs/{cid}

Deletes a catalog

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the catalog

200 OK

OK

Returns a catalog

GET /groups/{gid}/catalogs/{cid}

Returns a catalog

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the catalog

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "$scan": "boolean",
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}

Modifies a catalog

PUT /groups/{gid}/catalogs/{cid}

Modifies a catalog

undefined

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the catalog

Request Example
{
  "$scan": "boolean",
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}
200 OK

OK

Response Example (200 OK)
{
  "$scan": "boolean",
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}

Gets the contacts associated with a group

GET /groups/{gid}/contacts

Gets the contacts associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "available": "string",
    "city": "string",
    "count": "integer (int32)",
    "countryCode": "string",
    "email": "string",
    "fax": "string",
    "hash": "string",
    "name": "string",
    "organization": "string",
    "phone": "string",
    "type": "string",
    "zipCode": "string"
  }
]

Creates a new contact

POST /groups/{gid}/contacts

Creates a new contact

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

Deletes a contact

DELETE /groups/{gid}/contacts/{cid}

Deletes a contact

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the contact

200 OK

OK

Returns a contact

GET /groups/{gid}/contacts/{cid}

Returns a contact

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the contact

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

Modifies a contact

PUT /groups/{gid}/contacts/{cid}

Modifies a contact

undefined

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the contact

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

Gets the data sources associated with a group

GET /groups/{gid}/data-sources

Gets the data sources associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "enabled": "boolean",
    "lastSession": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    },
    "location": "string",
    "name": "string",
    "resourceCount": "integer (int32)",
    "sessions": [
      {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "progress": "number",
        "status": "string"
      }
    ]
  }
]

Creates a new data source

POST /groups/{gid}/data-sources

Creates a new data source

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "enabled": "boolean",
  "lastSession": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  },
  "location": "string",
  "name": "string",
  "resourceCount": "integer (int32)",
  "sessions": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    }
  ]
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "enabled": "boolean",
  "lastSession": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  },
  "location": "string",
  "name": "string",
  "resourceCount": "integer (int32)",
  "sessions": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    }
  ]
}

Deletes the specified data source

DELETE /groups/{gid}/data-sources/{did}

Deletes the specified data source

gid: string (uuid)
in path

The identifier of the workgroup

did: string (uuid)
in path

The identifier of the data source

200 OK

OK

Modifies the specified data source

PUT /groups/{gid}/data-sources/{did}

Modifies the specified data source

gid: string (uuid)
in path

The identifier of the workgroup

did: string (uuid)
in path

The identifier of the data source

200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "enabled": "boolean",
  "lastSession": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  },
  "location": "string",
  "name": "string",
  "resourceCount": "integer (int32)",
  "sessions": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    }
  ]
}

Gets the sessions for the specified data source

GET /groups/{gid}/data-sources/{did}/sessions

Gets the sessions for the specified data source

gid: string (uuid)
in path

The identifier of the group

did: string (uuid)
in path

The identifier of the data source

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  }
]

Creates a new session

POST /groups/{gid}/data-sources/{did}/sessions

Creates a new session

undefined

gid: string (uuid)
in path

The identifier of the group

did: string (uuid)
in path

The identifier of the data source

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "progress": "number",
  "status": "string"
}
200 OK

OK

409 Conflict

A session has already been started for this data source

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "progress": "number",
  "status": "string"
}

Searches for keywords

GET /groups/{gid}/keywords/search

Searches for keywords in the specified group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

th: string[]
in query

Limits the search to the specified thesauri

_id: string[]
in query

Limits the search to the specified identifiers

tag: string[]
in query

Limits the search to the specified tags

_limit: integer (int32) 20
in query

Limits the number of results returned

_offset: integer (int32) 0
in query

Offset

ob: string count.group, count.isogeo, text text
in query

Specifies the order of the results

od: string asc, desc desc
in query

Specifies the direction of the order

q: string
in query

The search query

200 OK

OK

type
object
Response Example (200 OK)
{
  "limit": "integer (int32)",
  "offset": "integer (int32)",
  "results": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "_tag": "string",
      "code": "string",
      "count": {
        "group": "integer (int32)",
        "isogeo": "integer (int32)"
      },
      "description": "string",
      "text": "string",
      "thesaurus": {
        "_abilities": [
          "string"
        ],
        "_id": "string (uuid)",
        "code": "string",
        "name": "string"
      }
    }
  ],
  "total": "integer (int32)"
}

Removes the specified keyword from the list of restricted keywords

DELETE /groups/{gid}/keywords/{kid}

Removes the specified keyword from the list of restricted keywords for the specified group

gid: string (uuid)
in path

The identifier of the workgroup

kid: string (uuid)
in path

The identifier of the data source

200 OK

OK

400 Bad Request

The specified keyword is set on some resources in the specified workgroup

404 Not Found

Keywords restriction has not been activated on the specified group. Or the specified keyword is not currently in the list of restricted keywords.

Adds the specified keyword to the list of restricted keywords

POST /groups/{gid}/keywords/{kid}

Adds the specified keyword to the list of restricted keywords for the specified group

gid: string (uuid)
in path

The identifier of the workgroup

kid: string (uuid)
in path

The identifier of the data source

200 OK

OK

404 Not Found

Keywords restriction has not been activated on the specified group

409 Conflict

The specified keyword is already in the list of restricted keywords

Gets the licenses associated with a group

GET /groups/{gid}/licenses

Gets the licenses associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "content": "string",
    "count": "integer (int32)",
    "link": "string",
    "name": "string"
  }
]

Creates a new license

POST /groups/{gid}/licenses

Creates a new license

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

Deletes a license

DELETE /groups/{gid}/licenses/{lid}

Deletes a license

gid: string (uuid)
in path

The identifier of the group

lid: string (uuid)
in path

The identifier of the license

200 OK

OK

Returns a license

GET /groups/{gid}/licenses/{lid}

Returns a license

gid: string (uuid)
in path

The identifier of the group

lid: string (uuid)
in path

The identifier of the license

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

Modifies a license

PUT /groups/{gid}/licenses/{lid}

Modifies a license

undefined

gid: string (uuid)
in path

The identifier of the group

lid: string (uuid)
in path

The identifier of the license

Request Example
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

Deletes a specification

DELETE /groups/{gid}/specification/{sid}

Deletes a specification

gid: string (uuid)
in path

The identifier of the group

sid: string (uuid)
in path

The identifier of the specification

200 OK

OK

Returns a specification

GET /groups/{gid}/specification/{sid}

Returns a specification

gid: string (uuid)
in path

The identifier of the group

sid: string (uuid)
in path

The identifier of the specification

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

Modifies a specification

PUT /groups/{gid}/specification/{sid}

Modifies a specification

undefined

gid: string (uuid)
in path

The identifier of the group

sid: string (uuid)
in path

The identifier of the specification

Request Example
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

Gets the specifications associated with a group

GET /groups/{gid}/specifications

Gets the sepcifications associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "count": "integer (int32)",
    "link": "string",
    "name": "string",
    "published": "string (date-time)"
  }
]

Creates a new specification

POST /groups/{gid}/specifications

Creates a new specification

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

Returns the statistics for the specified group

GET /groups/{gid}/statistics

Returns the statistics for the specified group

gid: string (uuid)
in path

The identifier of the group

200 OK

OK

type
object
Response Example (200 OK)
{
  "cataloged": "integer (int32)",
  "contacts": "integer (int32)",
  "coordinateSystems": "integer (int32)",
  "featureAttributes": "integer (int32)",
  "features": "integer (int32)",
  "formats": "integer (int32)",
  "inspireThemes": "integer (int32)",
  "keywords": "integer (int32)",
  "metadata": "integer (int32)",
  "owners": "integer (int32)",
  "rasters": "integer (int32)",
  "vectors": "integer (int32)"
}

Returns the statistics for the specified tag

GET /groups/{gid}/statistics/tag/{tag}

Returns the statistics for the specified tag in the specified group

gid: string (uuid)
in path

The identifier of the group

tag: string catalog, coordinate-system, format, keyword:inspire-theme, keyword, owner
in path

The tag

200 OK

OK

type
object[]
Response Example (200 OK)
[
  {
    "count": "integer (int32)",
    "entity": "object"
  }
]

contact

Returns a contact

GET /contacts/{cid}

Returns a contact

cid: string (uuid)
in path

The identifier of the contact

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

Gets the contacts associated with a group

GET /groups/{gid}/contacts

Gets the contacts associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "available": "string",
    "city": "string",
    "count": "integer (int32)",
    "countryCode": "string",
    "email": "string",
    "fax": "string",
    "hash": "string",
    "name": "string",
    "organization": "string",
    "phone": "string",
    "type": "string",
    "zipCode": "string"
  }
]

Creates a new contact

POST /groups/{gid}/contacts

Creates a new contact

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

Deletes a contact

DELETE /groups/{gid}/contacts/{cid}

Deletes a contact

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the contact

200 OK

OK

Returns a contact

GET /groups/{gid}/contacts/{cid}

Returns a contact

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the contact

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

Modifies a contact

PUT /groups/{gid}/contacts/{cid}

Modifies a contact

undefined

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the contact

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

catalog

Gets the catalogs associated with a group

GET /groups/{gid}/catalogs

Gets the catalogs of a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "$scan": "boolean",
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "_tag": "string",
    "code": "string",
    "count": "integer (int32)",
    "name": "string",
    "owner": {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  }
]

Creates a new catalog

POST /groups/{gid}/catalogs

Creates a new catalog

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "$scan": "boolean",
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}
200 OK

OK

Response Example (200 OK)
{
  "$scan": "boolean",
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}

Deletes a catalog

DELETE /groups/{gid}/catalogs/{cid}

Deletes a catalog

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the catalog

200 OK

OK

Returns a catalog

GET /groups/{gid}/catalogs/{cid}

Returns a catalog

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the catalog

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "$scan": "boolean",
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}

Modifies a catalog

PUT /groups/{gid}/catalogs/{cid}

Modifies a catalog

undefined

gid: string (uuid)
in path

The identifier of the group

cid: string (uuid)
in path

The identifier of the catalog

Request Example
{
  "$scan": "boolean",
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}
200 OK

OK

Response Example (200 OK)
{
  "$scan": "boolean",
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}

data-source

Gets the data sources associated with a group

GET /groups/{gid}/data-sources

Gets the data sources associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "enabled": "boolean",
    "lastSession": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    },
    "location": "string",
    "name": "string",
    "resourceCount": "integer (int32)",
    "sessions": [
      {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "progress": "number",
        "status": "string"
      }
    ]
  }
]

Creates a new data source

POST /groups/{gid}/data-sources

Creates a new data source

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "enabled": "boolean",
  "lastSession": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  },
  "location": "string",
  "name": "string",
  "resourceCount": "integer (int32)",
  "sessions": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    }
  ]
}
200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "enabled": "boolean",
  "lastSession": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  },
  "location": "string",
  "name": "string",
  "resourceCount": "integer (int32)",
  "sessions": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    }
  ]
}

Deletes the specified data source

DELETE /groups/{gid}/data-sources/{did}

Deletes the specified data source

gid: string (uuid)
in path

The identifier of the workgroup

did: string (uuid)
in path

The identifier of the data source

200 OK

OK

Modifies the specified data source

PUT /groups/{gid}/data-sources/{did}

Modifies the specified data source

gid: string (uuid)
in path

The identifier of the workgroup

did: string (uuid)
in path

The identifier of the data source

200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "enabled": "boolean",
  "lastSession": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  },
  "location": "string",
  "name": "string",
  "resourceCount": "integer (int32)",
  "sessions": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    }
  ]
}

Gets the sessions for the specified data source

GET /groups/{gid}/data-sources/{did}/sessions

Gets the sessions for the specified data source

gid: string (uuid)
in path

The identifier of the group

did: string (uuid)
in path

The identifier of the data source

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  }
]

Creates a new session

POST /groups/{gid}/data-sources/{did}/sessions

Creates a new session

undefined

gid: string (uuid)
in path

The identifier of the group

did: string (uuid)
in path

The identifier of the data source

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "progress": "number",
  "status": "string"
}
200 OK

OK

409 Conflict

A session has already been started for this data source

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "progress": "number",
  "status": "string"
}

session

Gets the sessions for the specified data source

GET /groups/{gid}/data-sources/{did}/sessions

Gets the sessions for the specified data source

gid: string (uuid)
in path

The identifier of the group

did: string (uuid)
in path

The identifier of the data source

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  }
]

Creates a new session

POST /groups/{gid}/data-sources/{did}/sessions

Creates a new session

undefined

gid: string (uuid)
in path

The identifier of the group

did: string (uuid)
in path

The identifier of the data source

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "progress": "number",
  "status": "string"
}
200 OK

OK

409 Conflict

A session has already been started for this data source

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "progress": "number",
  "status": "string"
}

keyword

Searches for keywords

GET /groups/{gid}/keywords/search

Searches for keywords in the specified group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

th: string[]
in query

Limits the search to the specified thesauri

_id: string[]
in query

Limits the search to the specified identifiers

tag: string[]
in query

Limits the search to the specified tags

_limit: integer (int32) 20
in query

Limits the number of results returned

_offset: integer (int32) 0
in query

Offset

ob: string count.group, count.isogeo, text text
in query

Specifies the order of the results

od: string asc, desc desc
in query

Specifies the direction of the order

q: string
in query

The search query

200 OK

OK

type
object
Response Example (200 OK)
{
  "limit": "integer (int32)",
  "offset": "integer (int32)",
  "results": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "_tag": "string",
      "code": "string",
      "count": {
        "group": "integer (int32)",
        "isogeo": "integer (int32)"
      },
      "description": "string",
      "text": "string",
      "thesaurus": {
        "_abilities": [
          "string"
        ],
        "_id": "string (uuid)",
        "code": "string",
        "name": "string"
      }
    }
  ],
  "total": "integer (int32)"
}

Removes the specified keyword from the list of restricted keywords

DELETE /groups/{gid}/keywords/{kid}

Removes the specified keyword from the list of restricted keywords for the specified group

gid: string (uuid)
in path

The identifier of the workgroup

kid: string (uuid)
in path

The identifier of the data source

200 OK

OK

400 Bad Request

The specified keyword is set on some resources in the specified workgroup

404 Not Found

Keywords restriction has not been activated on the specified group. Or the specified keyword is not currently in the list of restricted keywords.

Adds the specified keyword to the list of restricted keywords

POST /groups/{gid}/keywords/{kid}

Adds the specified keyword to the list of restricted keywords for the specified group

gid: string (uuid)
in path

The identifier of the workgroup

kid: string (uuid)
in path

The identifier of the data source

200 OK

OK

404 Not Found

Keywords restriction has not been activated on the specified group

409 Conflict

The specified keyword is already in the list of restricted keywords

Returns a keyword

GET /keywords/{kid}

Returns the specified keywords

kid: string (uuid)
in path

The identifier of the keyword

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": {
    "group": "integer (int32)",
    "isogeo": "integer (int32)"
  },
  "description": "string",
  "text": "string",
  "thesaurus": {
    "_abilities": [
      "string"
    ],
    "_id": "string (uuid)",
    "code": "string",
    "name": "string"
  }
}

Returns the keywords of a resource

GET /resources/{rid}/keywords

Returns the keywords of a resource

rid: string (uuid)
in path

The identifier of the resource

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "_tag": "string",
    "code": "string",
    "count": {
      "group": "integer (int32)",
      "isogeo": "integer (int32)"
    },
    "description": "string",
    "text": "string",
    "thesaurus": {
      "_abilities": [
        "string"
      ],
      "_id": "string (uuid)",
      "code": "string",
      "name": "string"
    }
  }
]

Removes the specified keyword

DELETE /resources/{rid}/keywords/{kid}

Removes the specified keyword from the specified resource

rid: string (uuid)
in path

The identifier of the resource

kid: string (uuid)
in path

The identifier of the keyword

200 OK

OK

404 Not Found

Either the resource or the keyword does not exist. Or the keyword is not associated to the specified resource.

Associates the specified keyword with the specified resource

POST /resources/{rid}/keywords/{kid}

Associates the specified keyword with the specified resource

rid: string (uuid)
in path

The identifier of the resource

kid: string (uuid)
in path

The identifier of the keyword

200 OK

OK

404 Not Found

Either the resource or the keyword does not exist. Or the keyword is not part of the list of restricted keywords.

409 Conflict

The association has already been made

Creates a keyword in the specified thesaurus

POST /thesauri/{tid}/keywords

Creates a keyword in the specified thesaurus

undefined

tid: string (uuid)
in path

The identifier of the thesaurus

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": {},
  "description": "string",
  "text": "string",
  "thesaurus": {
    "_id": "string (uuid)",
    "code": "string",
    "name": "string"
  }
}
200 OK

OK

Response Example (200 OK)
{
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": {
    "group": "integer (int32)",
    "isogeo": "integer (int32)"
  },
  "description": "string",
  "text": "string",
  "thesaurus": {
    "_abilities": [
      "string"
    ],
    "_id": "string (uuid)",
    "code": "string",
    "name": "string"
  }
}

Searches for keywords

GET /thesauri/{tid}/keywords/search

Searches for keywords in the specified thesaurus

tid: string (uuid)
in path

The identifier of the thesaurus

_include: string[]
in query

Indicates subresources that should be returned

_id: string[]
in query

Limits the search to the specified identifiers

tag: string[]
in query

Limits the search to the specified tags

_limit: integer (int32) 20
in query

Limits the number of results returned

_offset: integer (int32) 0
in query

Offset

ob: string count.isogeo, text text
in query

Specifies the order of the results

od: string asc, desc desc
in query

Specifies the direction of the order

q: string
in query

The search query

200 OK

OK

type
object
Response Example (200 OK)
{
  "limit": "integer (int32)",
  "offset": "integer (int32)",
  "results": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "_tag": "string",
      "code": "string",
      "count": {
        "group": "integer (int32)",
        "isogeo": "integer (int32)"
      },
      "description": "string",
      "text": "string",
      "thesaurus": {
        "_abilities": [
          "string"
        ],
        "_id": "string (uuid)",
        "code": "string",
        "name": "string"
      }
    }
  ],
  "total": "integer (int32)"
}

Deletes the specified keyword

DELETE /thesauri/{tid}/keywords/{kid}

Deletes the specified keyword

tid: string (uuid)
in path

The identifier of the thesaurus

kid: string (uuid)
in path

The identifier of the keyword

200 OK

OK

license

Gets the licenses associated with a group

GET /groups/{gid}/licenses

Gets the licenses associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "content": "string",
    "count": "integer (int32)",
    "link": "string",
    "name": "string"
  }
]

Creates a new license

POST /groups/{gid}/licenses

Creates a new license

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

Deletes a license

DELETE /groups/{gid}/licenses/{lid}

Deletes a license

gid: string (uuid)
in path

The identifier of the group

lid: string (uuid)
in path

The identifier of the license

200 OK

OK

Returns a license

GET /groups/{gid}/licenses/{lid}

Returns a license

gid: string (uuid)
in path

The identifier of the group

lid: string (uuid)
in path

The identifier of the license

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

Modifies a license

PUT /groups/{gid}/licenses/{lid}

Modifies a license

undefined

gid: string (uuid)
in path

The identifier of the group

lid: string (uuid)
in path

The identifier of the license

Request Example
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

Returns a license

GET /licenses/{lid}

Returns a license

lid: string (uuid)
in path

The identifier of the license

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

group

Search resources

GET /groups/{gid}/resources/search

Search resources that are accessible to the specified group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

_id: string[]
in query

Limits the search to the specified identifiers

_limit: integer (int32) 20
in query

Limits the number of results returned

_offset: integer (int32)
in query

Offset

box: number[]
in query

Bounding box for the search

geo: string
in query

Geographic criteria for the search, in WKT format

rel: string contains, disjoint, equals, intersects, overlaps, within
in query

The spatial operator for the search

ob: string _created, _modified, title, created, modified _created
in query

Specifies the order of the results

od: string asc, desc desc
in query

Specifies the direction of the order

q: string
in query

The search query

200 OK

OK

type
object
Response Example (200 OK)
{
  "envelope": "object",
  "limit": "integer (int32)",
  "offset": "integer (int32)",
  "query": "object",
  "results": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_creator": {
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "areKeywordsRestricted": "boolean",
        "canCreateMetadata": "boolean",
        "code": "string",
        "contact": {
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "available": "string",
          "city": "string",
          "count": "integer (int32)",
          "countryCode": "string",
          "email": "string",
          "fax": "string",
          "hash": "string",
          "name": "string",
          "organization": "string",
          "phone": "string",
          "type": "string",
          "zipCode": "string"
        },
        "keywordsCasing": "string",
        "metadataLanguage": "string",
        "themeColor": "string"
      },
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "abstract": "string",
      "bbox": [
        "number (double)"
      ],
      "collectionContext": "string",
      "collectionMethod": "string",
      "conditions": [
        {
          "_id": "string (uuid)",
          "description": "string",
          "license": {
            "_id": "string (uuid)",
            "content": "string",
            "count": "integer (int32)",
            "link": "string",
            "name": "string"
          }
        }
      ],
      "contacts": [
        {
          "_id": "string (uuid)",
          "contact": {
            "_created": "string (date-time)",
            "_id": "string (uuid)",
            "_modified": "string (date-time)",
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "available": "string",
            "city": "string",
            "count": "integer (int32)",
            "countryCode": "string",
            "email": "string",
            "fax": "string",
            "hash": "string",
            "name": "string",
            "organization": "string",
            "phone": "string",
            "type": "string",
            "zipCode": "string"
          },
          "role": "string"
        }
      ],
      "context": "object",
      "coordinate-system": "object",
      "created": "string (date-time)",
      "distance": "number (double)",
      "editionProfile": "string",
      "encoding": "string",
      "envelope": "object",
      "features": "integer (int32)",
      "format": "string"
    }
  ]
}

resource

Search resources

GET /groups/{gid}/resources/search

Search resources that are accessible to the specified group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

_id: string[]
in query

Limits the search to the specified identifiers

_limit: integer (int32) 20
in query

Limits the number of results returned

_offset: integer (int32)
in query

Offset

box: number[]
in query

Bounding box for the search

geo: string
in query

Geographic criteria for the search, in WKT format

rel: string contains, disjoint, equals, intersects, overlaps, within
in query

The spatial operator for the search

ob: string _created, _modified, title, created, modified _created
in query

Specifies the order of the results

od: string asc, desc desc
in query

Specifies the direction of the order

q: string
in query

The search query

200 OK

OK

type
object
Response Example (200 OK)
{
  "envelope": "object",
  "limit": "integer (int32)",
  "offset": "integer (int32)",
  "query": "object",
  "results": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_creator": {
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "areKeywordsRestricted": "boolean",
        "canCreateMetadata": "boolean",
        "code": "string",
        "contact": {
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "available": "string",
          "city": "string",
          "count": "integer (int32)",
          "countryCode": "string",
          "email": "string",
          "fax": "string",
          "hash": "string",
          "name": "string",
          "organization": "string",
          "phone": "string",
          "type": "string",
          "zipCode": "string"
        },
        "keywordsCasing": "string",
        "metadataLanguage": "string",
        "themeColor": "string"
      },
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "abstract": "string",
      "bbox": [
        "number (double)"
      ],
      "collectionContext": "string",
      "collectionMethod": "string",
      "conditions": [
        {
          "_id": "string (uuid)",
          "description": "string",
          "license": {
            "_id": "string (uuid)",
            "content": "string",
            "count": "integer (int32)",
            "link": "string",
            "name": "string"
          }
        }
      ],
      "contacts": [
        {
          "_id": "string (uuid)",
          "contact": {
            "_created": "string (date-time)",
            "_id": "string (uuid)",
            "_modified": "string (date-time)",
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "available": "string",
            "city": "string",
            "count": "integer (int32)",
            "countryCode": "string",
            "email": "string",
            "fax": "string",
            "hash": "string",
            "name": "string",
            "organization": "string",
            "phone": "string",
            "type": "string",
            "zipCode": "string"
          },
          "role": "string"
        }
      ],
      "context": "object",
      "coordinate-system": "object",
      "created": "string (date-time)",
      "distance": "number (double)",
      "editionProfile": "string",
      "encoding": "string",
      "envelope": "object",
      "features": "integer (int32)",
      "format": "string"
    }
  ]
}

Search resources

GET /resources/search

Search resources

_include: string[]
in query

Indicates subresources that should be returned

_id: string[]
in query

Limits the search to the specified identifiers

_limit: integer (int32) 20
in query

Limits the number of results returned

_offset: integer (int32)
in query

Offset

box: number[]
in query

Bounding box for the search

geo: string
in query

Geographic criteria for the search, in WKT format

rel: string contains, disjoint, equals, intersects, overlaps, within
in query

The spatial operator for the search

ob: string _created, _modified, title, created, modified _created
in query

Specifies the order of the results

od: string asc, desc desc
in query

Specifies the direction of the order

q: string
in query

The search query

200 OK

OK

type
object
Response Example (200 OK)
{
  "envelope": "object",
  "limit": "integer (int32)",
  "offset": "integer (int32)",
  "query": "object",
  "results": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_creator": {
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "areKeywordsRestricted": "boolean",
        "canCreateMetadata": "boolean",
        "code": "string",
        "contact": {
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "available": "string",
          "city": "string",
          "count": "integer (int32)",
          "countryCode": "string",
          "email": "string",
          "fax": "string",
          "hash": "string",
          "name": "string",
          "organization": "string",
          "phone": "string",
          "type": "string",
          "zipCode": "string"
        },
        "keywordsCasing": "string",
        "metadataLanguage": "string",
        "themeColor": "string"
      },
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "abstract": "string",
      "bbox": [
        "number (double)"
      ],
      "collectionContext": "string",
      "collectionMethod": "string",
      "conditions": [
        {
          "_id": "string (uuid)",
          "description": "string",
          "license": {
            "_id": "string (uuid)",
            "content": "string",
            "count": "integer (int32)",
            "link": "string",
            "name": "string"
          }
        }
      ],
      "contacts": [
        {
          "_id": "string (uuid)",
          "contact": {
            "_created": "string (date-time)",
            "_id": "string (uuid)",
            "_modified": "string (date-time)",
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "available": "string",
            "city": "string",
            "count": "integer (int32)",
            "countryCode": "string",
            "email": "string",
            "fax": "string",
            "hash": "string",
            "name": "string",
            "organization": "string",
            "phone": "string",
            "type": "string",
            "zipCode": "string"
          },
          "role": "string"
        }
      ],
      "context": "object",
      "coordinate-system": "object",
      "created": "string (date-time)",
      "distance": "number (double)",
      "editionProfile": "string",
      "encoding": "string",
      "envelope": "object",
      "features": "integer (int32)",
      "format": "string"
    }
  ]
}

Returns a resource

GET /resources/{id}

Returns a resource

id: string (uuid)
in path

The identifier of the resource

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_creator": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  },
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "abstract": "string",
  "bbox": [
    "number (double)"
  ],
  "collectionContext": "string",
  "collectionMethod": "string",
  "conditions": [
    {
      "_id": "string (uuid)",
      "description": "string",
      "license": {
        "_id": "string (uuid)",
        "content": "string",
        "count": "integer (int32)",
        "link": "string",
        "name": "string"
      }
    }
  ],
  "contacts": [
    {
      "_id": "string (uuid)",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "role": "string"
    }
  ],
  "context": "object",
  "coordinate-system": "object",
  "created": "string (date-time)",
  "distance": "number (double)",
  "editionProfile": "string",
  "encoding": "string",
  "envelope": "object",
  "features": "integer (int32)",
  "format": "string",
  "formatVersion": "string",
  "geometry": "string",
  "height": "integer (int32)",
  "keywords": [
    {}
  ]
}

Returns a resource in ISO 19139 format

GET /resources/{rid}.xml

Returns a resource in ISO 19139 format

rid: string (uuid)
in path

The identifier of the resource

proxyUrl: string
in query

The URL of a proxy

200 OK

OK

Response Content-Types: application/xml

Returns the contacts of a resource

GET /resources/{rid}/contacts

Returns the contacts of a resource

rid: string (uuid)
in path

The identifier of the resource

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "role": "string"
  }
]

Returns the events of a resource

GET /resources/{rid}/events

Returns the events of a resource

rid: string (uuid)
in path

The identifier of the resource

200 OK

OK

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "date": "string (date-time)",
    "description": "string",
    "kind": "string"
  }
]

Returns the keywords of a resource

GET /resources/{rid}/keywords

Returns the keywords of a resource

rid: string (uuid)
in path

The identifier of the resource

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "_tag": "string",
    "code": "string",
    "count": {
      "group": "integer (int32)",
      "isogeo": "integer (int32)"
    },
    "description": "string",
    "text": "string",
    "thesaurus": {
      "_abilities": [
        "string"
      ],
      "_id": "string (uuid)",
      "code": "string",
      "name": "string"
    }
  }
]

Removes the specified keyword

DELETE /resources/{rid}/keywords/{kid}

Removes the specified keyword from the specified resource

rid: string (uuid)
in path

The identifier of the resource

kid: string (uuid)
in path

The identifier of the keyword

200 OK

OK

404 Not Found

Either the resource or the keyword does not exist. Or the keyword is not associated to the specified resource.

Associates the specified keyword with the specified resource

POST /resources/{rid}/keywords/{kid}

Associates the specified keyword with the specified resource

rid: string (uuid)
in path

The identifier of the resource

kid: string (uuid)
in path

The identifier of the keyword

200 OK

OK

404 Not Found

Either the resource or the keyword does not exist. Or the keyword is not part of the list of restricted keywords.

409 Conflict

The association has already been made

Returns the layers of a service

GET /resources/{rid}/layers

Returns the layers of a service

rid: string (uuid)
in path

The identifier of the service

200 OK

OK

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "id": "string",
    "mimeTypes": [
      "string"
    ],
    "titles": [
      {
        "lang": "string",
        "value": "string"
      }
    ]
  }
]

Creates a new layer

POST /resources/{rid}/layers

Creates a new layer

undefined

rid: string (uuid)
in path

The identifier of the service

Request Example
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}

Deletes a layer

DELETE /resources/{rid}/layers/{lid}

Deletes a layer

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

200 OK

OK

Returns the layer of a service

GET /resources/{rid}/layers/{lid}

Returns the layer of a service

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}

Modifies a layer

PUT /resources/{rid}/layers/{lid}

Modifies a layer

undefined

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

Request Example
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}

Deletes the association between a service layer and a dataset

DELETE /resources/{rid}/layers/{lid}/dataset/{did}

Deletes the association between a service layer and a dataset

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

did: string (uuid)
in path

The identifier of the dataset

200 OK

OK

404 Not Found

No such association exists

Creates the association between a service layer and a dataset

POST /resources/{rid}/layers/{lid}/dataset/{did}

Creates the association between a service layer and a dataset

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

did: string (uuid)
in path

The identifier of the dataset

200 OK

OK

409 Conflict

an association already exists for this layer

Returns the operations of a service

GET /resources/{rid}/operations

Returns the operations of a service

rid: string (uuid)
in path

The identifier of the service

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "mimeTypesIn": [
      "string"
    ],
    "mimeTypesOut": [
      "string"
    ],
    "name": "string",
    "url": "string",
    "verb": "string"
  }
]

Creates a new operation

POST /resources/{rid}/operations

Creates a new operation

undefined

rid: string (uuid)
in path

The identifier of the service

Request Example
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

Deletes an operation

DELETE /resources/{rid}/operations/{oid}

Deletes an operation

rid: string (uuid)
in path

The identifier of the service

oid: string (uuid)
in path

The identifier of the operation

200 OK

OK

Returns the operation of a service

GET /resources/{rid}/operations/{oid}

Returns the operation of a service

rid: string (uuid)
in path

The identifier of the service

oid: string (uuid)
in path

The identifier of the operation

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

Modifies an operation

PUT /resources/{rid}/operations/{oid}

Modifies an operation

undefined

rid: string (uuid)
in path

The identifier of the service

oid: string (uuid)
in path

The identifier of the operation

Request Example
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

specification

Deletes a specification

DELETE /groups/{gid}/specification/{sid}

Deletes a specification

gid: string (uuid)
in path

The identifier of the group

sid: string (uuid)
in path

The identifier of the specification

200 OK

OK

Returns a specification

GET /groups/{gid}/specification/{sid}

Returns a specification

gid: string (uuid)
in path

The identifier of the group

sid: string (uuid)
in path

The identifier of the specification

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

Modifies a specification

PUT /groups/{gid}/specification/{sid}

Modifies a specification

undefined

gid: string (uuid)
in path

The identifier of the group

sid: string (uuid)
in path

The identifier of the specification

Request Example
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

Gets the specifications associated with a group

GET /groups/{gid}/specifications

Gets the sepcifications associated with a group

gid: string (uuid)
in path

The identifier of the group

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "count": "integer (int32)",
    "link": "string",
    "name": "string",
    "published": "string (date-time)"
  }
]

Creates a new specification

POST /groups/{gid}/specifications

Creates a new specification

undefined

gid: string (uuid)
in path

The identifier of the group

Request Example
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

Returns a specification

GET /specifications/{sid}

Returns a specification

sid: string (uuid)
in path

The identifier of the specification

_include: string[]
in query

Indicates subresources that should be returned

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "count": "integer (int32)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

event

Returns the events of a resource

GET /resources/{rid}/events

Returns the events of a resource

rid: string (uuid)
in path

The identifier of the resource

200 OK

OK

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "date": "string (date-time)",
    "description": "string",
    "kind": "string"
  }
]

layer

Returns the layers of a service

GET /resources/{rid}/layers

Returns the layers of a service

rid: string (uuid)
in path

The identifier of the service

200 OK

OK

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "id": "string",
    "mimeTypes": [
      "string"
    ],
    "titles": [
      {
        "lang": "string",
        "value": "string"
      }
    ]
  }
]

Creates a new layer

POST /resources/{rid}/layers

Creates a new layer

undefined

rid: string (uuid)
in path

The identifier of the service

Request Example
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}

Deletes a layer

DELETE /resources/{rid}/layers/{lid}

Deletes a layer

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

200 OK

OK

Returns the layer of a service

GET /resources/{rid}/layers/{lid}

Returns the layer of a service

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}

Modifies a layer

PUT /resources/{rid}/layers/{lid}

Modifies a layer

undefined

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

Request Example
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}
200 OK

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "id": "string",
  "mimeTypes": [
    "string"
  ],
  "titles": [
    {
      "lang": "string",
      "value": "string"
    }
  ]
}

Deletes the association between a service layer and a dataset

DELETE /resources/{rid}/layers/{lid}/dataset/{did}

Deletes the association between a service layer and a dataset

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

did: string (uuid)
in path

The identifier of the dataset

200 OK

OK

404 Not Found

No such association exists

Creates the association between a service layer and a dataset

POST /resources/{rid}/layers/{lid}/dataset/{did}

Creates the association between a service layer and a dataset

rid: string (uuid)
in path

The identifier of the service

lid: string (uuid)
in path

The identifier of the layer

did: string (uuid)
in path

The identifier of the dataset

200 OK

OK

409 Conflict

an association already exists for this layer

operation

Returns the operations of a service

GET /resources/{rid}/operations

Returns the operations of a service

rid: string (uuid)
in path

The identifier of the service

Response Example (200 OK)
[
  {
    "_id": "string (uuid)",
    "mimeTypesIn": [
      "string"
    ],
    "mimeTypesOut": [
      "string"
    ],
    "name": "string",
    "url": "string",
    "verb": "string"
  }
]

Creates a new operation

POST /resources/{rid}/operations

Creates a new operation

undefined

rid: string (uuid)
in path

The identifier of the service

Request Example
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

Deletes an operation

DELETE /resources/{rid}/operations/{oid}

Deletes an operation

rid: string (uuid)
in path

The identifier of the service

oid: string (uuid)
in path

The identifier of the operation

200 OK

OK

Returns the operation of a service

GET /resources/{rid}/operations/{oid}

Returns the operation of a service

rid: string (uuid)
in path

The identifier of the service

oid: string (uuid)
in path

The identifier of the operation

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

Modifies an operation

PUT /resources/{rid}/operations/{oid}

Modifies an operation

undefined

rid: string (uuid)
in path

The identifier of the service

oid: string (uuid)
in path

The identifier of the operation

Request Example
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

OK

Response Example (200 OK)
{
  "_id": "string (uuid)",
  "mimeTypesIn": [
    "string"
  ],
  "mimeTypesOut": [
    "string"
  ],
  "name": "string",
  "url": "string",
  "verb": "string"
}

shares

Returns the shares

GET /shares

Returns the list of shares accessible

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_created": "string (date-time)",
    "_creator": {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    },
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "applications": [
      {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "canHaveManyGroups": "boolean",
        "client_id": "string",
        "client_secret": "string",
        "groups": [
          {
            "_abilities": [
              "string"
            ],
            "_created": "string (date-time)",
            "_id": "string (uuid)",
            "_modified": "string (date-time)",
            "areKeywordsRestricted": "boolean",
            "canCreateMetadata": "boolean",
            "code": "string",
            "contact": {
              "_created": "string (date-time)",
              "_id": "string (uuid)",
              "_modified": "string (date-time)",
              "addressLine1": "string",
              "addressLine2": "string",
              "addressLine3": "string",
              "available": "string",
              "city": "string",
              "count": "integer (int32)",
              "countryCode": "string",
              "email": "string",
              "fax": "string",
              "hash": "string",
              "name": "string",
              "organization": "string",
              "phone": "string",
              "type": "string",
              "zipCode": "string"
            },
            "keywordsCasing": "string",
            "metadataLanguage": "string",
            "themeColor": "string"
          }
        ],
        "kind": "string",
        "name": "string",
        "redirect_uris": [
          "string"
        ],
        "scopes": [
          "string"
        ],
        "staff": "boolean",
        "url": "string"
      }
    ],
    "catalogs": [
      {
        "$scan": "boolean",
        "_abilities": [
          "string"
        ],
        "_created": "string (date-time)"
      }
    ]
  }
]

share

Returns a share

GET /shares/{sid}

Returns a share

sid: string (uuid)
in path

The identifier of the shares

200 OK

OK

Response Example (200 OK)
{
  "_created": "string (date-time)",
  "_creator": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  },
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "applications": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "canHaveManyGroups": "boolean",
      "client_id": "string",
      "client_secret": "string",
      "groups": [
        {
          "_abilities": [
            "string"
          ],
          "_created": "string (date-time)",
          "_id": "string (uuid)",
          "_modified": "string (date-time)",
          "areKeywordsRestricted": "boolean",
          "canCreateMetadata": "boolean",
          "code": "string",
          "contact": {
            "_created": "string (date-time)",
            "_id": "string (uuid)",
            "_modified": "string (date-time)",
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "available": "string",
            "city": "string",
            "count": "integer (int32)",
            "countryCode": "string",
            "email": "string",
            "fax": "string",
            "hash": "string",
            "name": "string",
            "organization": "string",
            "phone": "string",
            "type": "string",
            "zipCode": "string"
          },
          "keywordsCasing": "string",
          "metadataLanguage": "string",
          "themeColor": "string"
        }
      ],
      "kind": "string",
      "name": "string",
      "redirect_uris": [
        "string"
      ],
      "scopes": [
        "string"
      ],
      "staff": "boolean",
      "url": "string"
    }
  ],
  "catalogs": [
    {
      "$scan": "boolean",
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)"
    }
  ]
}

thesaurus

Returns the thesauri

GET /thesauri

Returns the list of thesauri

200 OK

OK

type
Response Example (200 OK)
[
  {
    "_abilities": [
      "string"
    ],
    "_id": "string (uuid)",
    "code": "string",
    "name": "string"
  }
]

Returns a thesaurus

GET /thesauri/{tid}

Returns a thesaurus

tid: string (uuid)
in path

The identifier of the thesaurus

200 OK

OK

Response Example (200 OK)
{
  "_abilities": [
    "string"
  ],
  "_id": "string (uuid)",
  "code": "string",
  "name": "string"
}

Creates a keyword in the specified thesaurus

POST /thesauri/{tid}/keywords

Creates a keyword in the specified thesaurus

undefined

tid: string (uuid)
in path

The identifier of the thesaurus

Request Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": {},
  "description": "string",
  "text": "string",
  "thesaurus": {
    "_id": "string (uuid)",
    "code": "string",
    "name": "string"
  }
}
200 OK

OK

Response Example (200 OK)
{
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": {
    "group": "integer (int32)",
    "isogeo": "integer (int32)"
  },
  "description": "string",
  "text": "string",
  "thesaurus": {
    "_abilities": [
      "string"
    ],
    "_id": "string (uuid)",
    "code": "string",
    "name": "string"
  }
}

Searches for keywords

GET /thesauri/{tid}/keywords/search

Searches for keywords in the specified thesaurus

tid: string (uuid)
in path

The identifier of the thesaurus

_include: string[]
in query

Indicates subresources that should be returned

_id: string[]
in query

Limits the search to the specified identifiers

tag: string[]
in query

Limits the search to the specified tags

_limit: integer (int32) 20
in query

Limits the number of results returned

_offset: integer (int32) 0
in query

Offset

ob: string count.isogeo, text text
in query

Specifies the order of the results

od: string asc, desc desc
in query

Specifies the direction of the order

q: string
in query

The search query

200 OK

OK

type
object
Response Example (200 OK)
{
  "limit": "integer (int32)",
  "offset": "integer (int32)",
  "results": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "_tag": "string",
      "code": "string",
      "count": {
        "group": "integer (int32)",
        "isogeo": "integer (int32)"
      },
      "description": "string",
      "text": "string",
      "thesaurus": {
        "_abilities": [
          "string"
        ],
        "_id": "string (uuid)",
        "code": "string",
        "name": "string"
      }
    }
  ],
  "total": "integer (int32)"
}

Deletes the specified keyword

DELETE /thesauri/{tid}/keywords/{kid}

Deletes the specified keyword

tid: string (uuid)
in path

The identifier of the thesaurus

kid: string (uuid)
in path

The identifier of the keyword

200 OK

OK

user

Deletes a user

DELETE /users/{id}

Deletes a user

id: string (uuid)
in path

The identifier of the user

200 OK

OK

Schema Definitions

_abilities: array

string
Example
[
  "string"
]

_bbox: array

number (double)
Example
[
  "number (double)"
]

_tags: array

object
Example
[
  "object"
]

application: object

_created: string (date-time)
_id: string (uuid)
_modified: string (date-time)
canHaveManyGroups: boolean
client_id: string

The OAuth 2.0 client identifier

client_secret: string

The OAuth 2.0 client secret

groups: workgroup
workgroup
kind: string group, user
name: string

The name of the application

redirect_uris: string[]
string
scopes: string[]
string
staff: boolean
url: string
Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "canHaveManyGroups": "boolean",
  "client_id": "string",
  "client_secret": "string",
  "groups": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "areKeywordsRestricted": "boolean",
      "canCreateMetadata": "boolean",
      "code": "string",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "keywordsCasing": "string",
      "metadataLanguage": "string",
      "themeColor": "string"
    }
  ],
  "kind": "string",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "staff": "boolean",
  "url": "string"
}

catalog: object

$scan: boolean
_abilities: _abilities
_created: string (date-time)
_id: string (uuid)
_modified: string (date-time)
_tag: string
code: string
count: integer (int32)
name: string
owner: workgroup
Example
{
  "$scan": "boolean",
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": "integer (int32)",
  "name": "string",
  "owner": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  }
}

contact: object

_created: string (date-time)
_id: string (uuid)
_modified: string (date-time)
addressLine1: string
addressLine2: string
addressLine3: string
available: string
city: string
count: integer (int32)
countryCode: string
email: string
fax: string
hash: string
name: string
organization: string
phone: string
type: string custom, group, user
zipCode: string
Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "available": "string",
  "city": "string",
  "count": "integer (int32)",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "string"
}

data-source: object

_created: string (date-time)
_id: string (uuid)
_modified: string (date-time)
enabled: boolean
lastSession: session
location: string
name: string
resourceCount: integer (int32)
sessions: session
session
Example
{
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "enabled": "boolean",
  "lastSession": {
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "progress": "number",
    "status": "string"
  },
  "location": "string",
  "name": "string",
  "resourceCount": "integer (int32)",
  "sessions": [
    {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "progress": "number",
      "status": "string"
    }
  ]
}

keyword: object

_abilities: _abilities
_created: string (date-time)
_id: string (uuid)
_modified: string (date-time)
_tag: string
code: string
count: object
group: integer (int32)
isogeo: integer (int32)
description: string
text: string
thesaurus: thesaurus
Example
{
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "_tag": "string",
  "code": "string",
  "count": {
    "group": "integer (int32)",
    "isogeo": "integer (int32)"
  },
  "description": "string",
  "text": "string",
  "thesaurus": {
    "_abilities": [
      "string"
    ],
    "_id": "string (uuid)",
    "code": "string",
    "name": "string"
  }
}

license: object

_id: string (uuid)
content: string
count: integer (int32)
link: string
name: string
Example
{
  "_id": "string (uuid)",
  "content": "string",
  "count": "integer (int32)",
  "link": "string",
  "name": "string"
}

resource: object

_abilities: _abilities
_created: string (date-time)
_creator: workgroup
_id: string (uuid)
_modified: string (date-time)
abstract: string
bbox: _bbox
collectionContext: string
collectionMethod: string
conditions: resourceCondition
resourceCondition
contacts: resourceContact
resourceContact
context: object
coordinate-system: object
created: string (date-time)
distance: number (double)
editionProfile: string csw, manual
encoding: string
envelope: object
features: integer (int32)
format: string
formatVersion: string
geometry: string
height: integer (int32)
keywords: keyword
keyword
language: string
layers: serviceLayer
serviceLayer
links: resourceLink
resourceLink
name: string
operations: serviceOperation
serviceOperation
path: string
published: string (date-time)
scale: integer (int32)
series: boolean
specifications: resourceConformity
resourceConformity
tags: _tags
title: string
topologicalConsistency: string
type: string rasterDataset, resource, service, vectorDataset
updateFrequency: string
updated: string (date-time)
validFrom: string (date-time)
validTo: string (date-time)
validityComment: string
width: integer (int32)
Example
{
  "_abilities": [
    "string"
  ],
  "_created": "string (date-time)",
  "_creator": {
    "_abilities": [
      "string"
    ],
    "_created": "string (date-time)",
    "_id": "string (uuid)",
    "_modified": "string (date-time)",
    "areKeywordsRestricted": "boolean",
    "canCreateMetadata": "boolean",
    "code": "string",
    "contact": {
      "_created": "string (date-time)",
      "_id": "string (uuid)",
      "_modified": "string (date-time)",
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "available": "string",
      "city": "string",
      "count": "integer (int32)",
      "countryCode": "string",
      "email": "string",
      "fax": "string",
      "hash": "string",
      "name": "string",
      "organization": "string",
      "phone": "string",
      "type": "string",
      "zipCode": "string"
    },
    "keywordsCasing": "string",
    "metadataLanguage": "string",
    "themeColor": "string"
  },
  "_id": "string (uuid)",
  "_modified": "string (date-time)",
  "abstract": "string",
  "bbox": [
    "number (double)"
  ],
  "collectionContext": "string",
  "collectionMethod": "string",
  "conditions": [
    {
      "_id": "string (uuid)",
      "description": "string",
      "license": {
        "_id": "string (uuid)",
        "content": "string",
        "count": "integer (int32)",
        "link": "string",
        "name": "string"
      }
    }
  ],
  "contacts": [
    {
      "_id": "string (uuid)",
      "contact": {
        "_created": "string (date-time)",
        "_id": "string (uuid)",
        "_modified": "string (date-time)",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "available": "string",
        "city": "string",
        "count": "integer (int32)",
        "countryCode": "string",
        "email": "string",
        "fax": "string",
        "hash": "string",
        "name": "string",
        "organization": "string",
        "phone": "string",
        "type": "string",
        "zipCode": "string"
      },
      "role": "string"
    }
  ],
  "context": "object",
  "coordinate-system": "object",
  "created": "string (date-time)",
  "distance": "number (double)",
  "editionProfile": "string",
  "encoding": "string",
  "envelope": "object",
  "features": "integer (int32)",
  "format": "string",
  "formatVersion": "string",
  "geometry": "string",
  "height": "integer (int32)",
  "keywords": [
    {}
  ]
}

resourceCondition: object