---
title: "Creates a data sample"
method: POST
path: "/data-samples"
tags: ["data samples"]
---

# Creates a data sample

`POST /data-samples`

You need `workspaces.flow.edit` permission to access this resource.

## Request body

- object
  - `data` object, required
    - `id` string, required
    - `type` 'data-sample', required — Allowed value: `data-sample`
    - `links` object, required
      - `self` string, required
    - `attributes` object, required
      - `method` string, required — Component’s action or trigger name.
      - `result` object, required — Data sample body
    - `relationships` object, required
      - `component` object, required
        - `data` object, required
          - `id` string, required — Component identifier
          - `type` 'component', required — A value must be `component`
        - `links` object, required
          - `self` string, required
      - `component_version` object, required
        - `data` object, required
          - `id` string, required — Revision of the component’s build. Use `latest` to retrieve the descriptor of the most recent successful build.
          - `type` 'version', required — A value must be `version`
        - `links` object, required
          - `self` string, required
      - `workspace` object, required
        - `data` object, required
          - `id` string, required
          - `type` 'workspace', required
        - `links` object, required
          - `self` string, required
      - `user` object
        - `data` object, required
          - `id` string, required
          - `type` 'user', required
        - `links` object, required
          - `self` string, required

## Response `201`

Created

- object
  - `data` object, required
    - `id` string, required
    - `type` 'data-sample', required — Allowed value: `data-sample`
    - `links` object, required
      - `self` string, required
    - `attributes` object, required
      - `method` string, required — Component’s action or trigger name.
      - `result` object, required — Data sample body
    - `relationships` object, required
      - `component` object, required
        - `data` object, required
          - `id` string, required — Component identifier
          - `type` 'component', required — A value must be `component`
        - `links` object, required
          - `self` string, required
      - `component_version` object, required
        - `data` object, required
          - `id` string, required — Revision of the component’s build. Use `latest` to retrieve the descriptor of the most recent successful build.
          - `type` 'version', required — A value must be `version`
        - `links` object, required
          - `self` string, required
      - `workspace` object, required
        - `data` object, required
          - `id` string, required
          - `type` 'workspace', required
        - `links` object, required
          - `self` string, required
      - `user` object
        - `data` object, required
          - `id` string, required
          - `type` 'user', required
        - `links` object, required
          - `self` string, required
  - `meta` object, required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/elastic/apis/elastic-io-rest-api-documentation-v2.md) · [All operations](https://skmtc.net/elastic/apis/elastic-io-rest-api-documentation-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/elastic-io-rest-api-documentation-v2/revisions/411f9f98c01e/schema)