Skip to main content

Create Links Dataset

Create a new empty Links dataset to link two different dataset types using the POST:Create Links Dataset endpoint

The following dataset types may be linked from or to

  • People
  • Positions
  • Roles
  • Activities
  • Competencies

The Dataset Id of both datasets to be linked is required to create the Links dataset. See Dataset Id for details on how to obtain your dataset id

The empty Links dataset will be created with the following default properties:

  • from_id
  • to_id
  • link_id
  • allocation

Once created the empty links dataset can then be populated with values

See Create, update or delete links for details on this endpoint

Example request body​

{
  "name": "PEOPLE to POSITIONS Links Dataset",
  "fromDatasetId": "99CD8A1B-61A2-4768-87FA-3D10420FC535",
  "toDatasetId": "2B44BAD6-6680-4A19-A00C-0366832E2BD6",
}

Example response​

{
  "datasetId": "6586F21B-AD4D-4D06-A309-712AF47184A2",
  "name": "PEOPLE to ROLES Links Dataset",
  "type": "LINKS",
  "createdBy": "user@example.com",
  "cacheKey": "abc5DeFgh3IjK5L76/ABCdeEFGHIJklMNo+pqRstuvwxYZENuHvV863y5BtEhGTuqnP2cLZhys9EQ==",
  "autoId": "link_id",
    "properties": [
    {
      "key": "from_id",
      "name": "from_id",
      "type": "string",
      "isRequired": true
    },
    {
      "key": "to_id",
      "name": "to_id",
      "type": "string",
      "isRequired": true
    },
    {
      "key": "link_id",
      "name": "link_id",
      "type": "string",
      "isRequired": true
    },
    {
      "key": "allocation",
      "name": "allocation",
      "type": "number",
      "isRequired": true
    }
  ]
}