PRprocess
Data Sets

Update a data set

Updates a data set's name and field definitions. Uses PUT semantics: the full field list is replaced. Returns the updated data set.

put/data-sets/{dataSetId}

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/data-sets/{dataSetId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

dataSetIdstring required

The ID of the Data Set

Request body

namestring required

Display name.

Response

Example response

{
  "data": {
    "id": "nvGOAYE3VjIBoZxtarR6yA",
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "fields": [
      {
        "createdBy": {
          "id": "paiZa0_oyxEBoZxtatp33g",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        },
        "updatedBy": {
          "id": "paiZa0_oyxEBoZxtatp33g",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      }
    ],
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.