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

workgroup

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

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

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

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

resource

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",
          "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",
            "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",
            "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)"
    }
  ]
}

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",
      "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",
        "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",
        "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": [
    {
      "_abilities": [
        "string"
      ]
    }
  ]
}

Returns a resource in ISO 19139 format

GET /resources/{id}.xml

Returns a resource in ISO 19139 format

id: 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/{id}/contacts

Returns the contacts of a resource

id: 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",
      "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"
    }
  }
]

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

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",
        "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",
              "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)",
        "_modified": "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",
      "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",
            "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)",
      "_modified": "string (date-time)",
      "_tag": "string"
    }
  ]
}

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

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

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",
        "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",
      "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
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",
  "countryCode": "string",
  "email": "string",
  "fax": "string",
  "hash": "string",
  "name": "string",
  "organization": "string",
  "phone": "string",
  "type": "string",
  "zipCode": "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
link: string
name: string
Example
{
  "_id": "string (uuid)",
  "content": "string",
  "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, daemon, 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",
      "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",
        "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",
        "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": [
    {
      "_abilities": [
        "string"
      ],
      "_created": "string (date-time)"
    }
  ]
}

resourceCondition: object

_id: string (uuid)
description: string
license: license
Example
{
  "_id": "string (uuid)",
  "description": "string",
  "license": {
    "_id": "string (uuid)",
    "content": "string",
    "link": "string",
    "name": "string"
  }
}

resourceConformity: object

_id: string (uuid)
conformant: boolean
license: specification
Example
{
  "_id": "string (uuid)",
  "conformant": "boolean",
  "license": {
    "_id": "string (uuid)",
    "link": "string",
    "name": "string",
    "published": "string (date-time)"
  }
}

resourceContact: object

_id: string (uuid)
contact: contact
role: string author, custodian, distributor, originator, owner, pointOfContact, principalInvestigator, processor, publisher, resourceProvider, user
Example
{
  "_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",
    "countryCode": "string",
    "email": "string",
    "fax": "string",
    "hash": "string",
    "name": "string",
    "organization": "string",
    "phone": "string",
    "type": "string",
    "zipCode": "string"
  },
  "role": "string"
}

resourceEvent: object

_id: string (uuid)
date: string (date-time)
description: string
kind: string creation, publication, update
Example
{
  "_id": "string (uuid)",
  "date": "string (date-time)",
  "description": "string",
  "kind": "string"
}

serviceLayer: object

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

serviceOperation: object

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

share: object

_created: string (date-time)
_creator: workgroup
_id: string (uuid)
_modified: string (date-time)
applications: application
application
catalogs: catalog
catalog
groups: workgroup
workgroup
name: string
rights: string[]
string
type: string application, group
Example
{
  "_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",
      "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",
            "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)",
      "_modified": "string (date-time)",
      "_tag": "string",
      "code": "string"
    }
  ]
}

specification: object

_id: string (uuid)
link: string
name: string
published: string (date-time)
Example
{
  "_id": "string (uuid)",
  "link": "string",
  "name": "string",
  "published": "string (date-time)"
}

thesaurus: object

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

workgroup: object

_abilities: _abilities
_created: string (date-time)
_id: string (uuid)
_modified: string (date-time)
areKeywordsRestricted: boolean
canCreateMetadata: boolean
code: string
contact: contact
keywordsCasing: string capitalized, lowercase, mixedcase, uppercase
metadataLanguage: string
themeColor: string
Example
{
  "_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",
    "countryCode": "string",
    "email": "string",
    "fax": "string",
    "hash": "string",
    "name": "string",
    "organization": "string",
    "phone": "string",
    "type": "string",
    "zipCode": "string"
  },
  "keywordsCasing": "string",
  "metadataLanguage": "string",
  "themeColor": "string"
}