---
title: "create data service"
method: POST
path: "/api/v1/data_services"
---

# create data service

`POST /api/v1/data_services`

## Request

- Base URL: `https://data-catalogue-staging.herokuapp.com`
- URL: `https://data-catalogue-staging.herokuapp.com/api/v1/data_services`
- Auth: HTTP basic

Creates a new data service

## Request body

- object
  - `data_service` object, required
    - `identifier` string, required: A unique number, code, or reference value assigned to an information resource within a given context. Local identifier for the resource
    - `title` string, required: A name given to the resource
    - `alternative_titles` string[]: Alternative names for the data resource including common abbreviations and synonyms
    - `summary` string: A couple of sentences summarising the data resource
    - `description` string, required: A detailed description of the data resource
    - `keywords` string[]: Uncontrolled terms (words or phrases) assigned to describe an information resource
    - `themes` string[]: A controlled term that expresses a topic of the intellectual content of an information resource
    - `licence` string, url, required: Reference to the legal document outlining access and usage rights for an information resource
    - `version` string, required: The version number of the data resource
    - `contact_name` string, required: Name of the point of contact or the team name
    - `contact_email` string, email, required: Email address for the point of contact. Preferable a team email address
    - `access_rights` 'INTERNAL' | 'OPEN' | 'COMMERCIAL', required: Information about who can access the resource or an indication of its security status
    - `security_classification` 'OFFICIAL' | 'SECRET' | 'TOP_SECRET', required: An information security designation that identifies the minimum level of protection assigned to an information resource
    - `issued` string, date: The date on which an information resource was originally published or otherwise made publicly available for the first time
    - `created` string, date: Date of creation of the resource
    - `modified` string, datetime, required: The date on which the content of an information resource is changed
    - `creators` string[]: The URI of the business entity responsible for creating or compiling the original content of an information resource
    - `publisher` string, uri, required: The URI of the business entity responsible for making an information resource publicly available
    - `related_data_resources` string[]: A collection of ids for data resources that relate to the resource
    - `endpoint_url` string, url: The root location or primary endpoint of the service (a Web-resolvable IRI)
    - `endpoint_description` string, required: A web-resolvable IRI containing a description of the services available via the end-points, including their operations, parameters etc
    - `serves_data` string[]: A collection of data that this data service can distribute
    - `service_type` 'EVENT' | 'REST' | 'SOAP': The nature or genre of the resource
    - `service_status` 'DISCOVERY' | 'ALPHA' | 'BETA' | 'PRIVATE_BETA' | 'PUBLIC_BETA' | 'LIVE' | 'DEPRECATED' | 'WITHDRAWN', required: The status of the resource in the context of a particular workflow process [VOCAB-ADMS]

## Response `201`

created

## Other responses

- `400`: bad_request
- `422`: unprocessable_entity

## Changes

- **2023-03-29** (v1) `e70183d58776`: 2 breaking
  - the `data_service/creators/items/` request property format changed from no format to `uri`
  - the `data_service/publisher` request property format changed from no format to `uri`
- **2023-03-24** (v1) `7b057473175a`: 2 breaking, 1 warning, 4 info
  - removed the enum value `OFFICIAL_SENSITIVE` of the request property `data_service/security_classification`
  - removed the enum value `PRODUCTION` of the request property `data_service/service_status`
  - removed the request property `data_service/enpoint_url`
  - added the new optional request property `data_service/endpoint_url`
  - …3 more
- **2023-03-24** (v1) `407df2ecfc94`: 1 warning, 1 info
  - removed the request property `data_service/alternative_title`
  - added the new optional request property `data_service/alternative_titles`
- **2023-03-24** (v1) `0d1e4e8290e7`: 6 breaking, 11 warning, 7 info
  - added the new required request property `data_service/access_rights`
  - added the new required request property `data_service/contact_email`
  - added the new required request property `data_service/contact_name`
  - added the new required request property `data_service/endpoint_description`
  - …20 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/central-digital-and-data-office/apis/datacatalogue-api-v1/changes/api/v1/data_services/post.md)

---

[API](https://skmtc.dev/central-digital-and-data-office/apis/datacatalogue-api-v1.md) - [All operations](https://skmtc.dev/central-digital-and-data-office/apis/datacatalogue-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/central-digital-and-data-office/apis/datacatalogue-api-v1/revisions/64da66c818ef?raw)