Sub-organization API

Sub-organizations represent customers of your organization. The sub-organization API allows you to collaborate with your customers on pipelines or even let them manage their own pipelines. Each sub-organization can access the pipelines, executions, connectors, and target data models they’ve created, as well as the connectors and target data models from your organization that are made public (permissions.level === "PUBLIC"). Use the authentication API to generate access tokens for each sub-organization, ensuring that everyone sees what they’re supposed to.

Use this base URL and add the corresponding endpoint respectively:

Base URL

api-gateway.getnuvo.com/dp/api/v1/

Create

Endpoint

POST /sub-organization/

Payload

Attributes

name

The name of the sub-organization

identifier

The identifier to uniquely recognize sub-organizations

permissions

Defines per pipeline component whether the sub-organization is allowed to create, read, update and delete them using boolean values

pipeline

Define whether the sub-organization can create, read, update and remove pipelines

create

Sets if the sub-organization can create new pipelines

read

Sets if the sub-organization can view single and all pipelines

write

Sets if the sub-organization can update pipelines

delete

Sets if the sub-organization can delete pipelines

execution

Defines whether the sub-organization can create, read, and fix executions

create

Sets if the sub-organization can create new executions

read

Sets if the sub-organization can view single and all executions

write

Sets if the sub-organization can fix executions

connector

Defines whether the sub-organization can create, read, update and remove connectors

create

Sets if the sub-organization can create new connectors

read

Sets if the sub-organization can view single and all connectors

write

Sets if the sub-organization can update connectors

delete

Sets if the sub-organization can delete connectors

tdm

Defines whether the sub-organization can create, read, update and remove target data models

create

Sets if the sub-organization can create new target data models

read

Sets if the sub-organization can view single and all target data models

write

Sets if the sub-organization can update target data models

delete

Sets if the sub-organization can delete target data models

Payload

{
  "name": "string",
  "identifier": "string",
  "permissions": {
    "pipeline": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "execution": {
      "create": true,
      "read": true,
      "write": true
    },
    "connector": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "tdm": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    }
  }
}

Response

Attributes

The ID of the sub-organization

name

The name of the sub-organization you want to add

identifier

The identifier to uniquely recognize sub-organization

permissions

Defines per pipeline component whether the sub-organization is allowed to create, read, update and delete them using boolean values

pipeline

Defines whether the sub-organization can create, read, update and remove pipelines

create

Sets if the sub-organization can create new pipelines

read

Sets if the sub-organization can view single and all pipelines

write

Sets if the sub-organization can update pipelines

delete

Sets if the sub-organization can delete pipelines

execution

Defines whether the sub-organization can create, read, and fix executions

create

Sets if the sub-organization can create new executions

read

Sets if the sub-organization can view single and all executions

write

Sets if the sub-organization can fix executions

connector

Defines whether the sub-organization can create, read, update and remove connectors

create

Sets if the sub-organization can create new connectors

read

Sets if the user can view single and all connectors

write

Sets if the user can update connectors

delete

Sets if the user can delete new connectors

tdm

Defines whether the sub-organization can create, read, update and remove target data models

create

Sets if the sub-organization can create new target data models

read

Sets if the sub-organization can view single and all target data models

write

Sets if the sub-organization can update target data models

delete

Sets if the sub-organization can delete target data models

created_at

The date and time when the sub-organization was first created

created_by

Information of whom created the sub-organization

The ID of the user who created the sub-organization

name

The name of the user who created the sub-organization

identifier

The identifier of the user who created the sub-organization

type

Defines the kind of user who created the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

updated_at

The date and time when the sub-organization was last updated

updated_by

Information of whom last updated the sub-organization

The ID of the user who last updated the sub-organization

name

The name of the user who last updated the sub-organization

identifier

The identifier of the user who last updated the sub-organization

type

Defines the kind of user who last updated the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "identifier": "string",
    "permissions": {
      "pipeline": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "execution": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "connector": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "tdm": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      }
    },
    "created_at": "2022-03-07 12:48:28.653",
      "created_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      },
    "updated_at": "2022-03-07 12:48:28.653",
    "updated_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      }
  }
}

Update

Endpoint

PUT /sub-organization/{id}

Payload

Attributes

name

The name of the sub-organization

identifier

The identifier to uniquely recognize sub-organizations

permissions

Defines per pipeline component whether the sub-organization is allowed to create, read, update and delete them using boolean values

pipeline

Defines whether the sub-organization can create, read, update and remove pipelines

create

Sets if the sub-organization can create new pipelines

read

Sets if the sub-organization can view single and all pipelines

write

Sets if the sub-organization can update pipelines

delete

Sets if the sub-organization can delete pipelines

execution

Defines whether the sub-organization can create, read, and fix executions

create

Sets if the sub-organization can create new executions

read

Sets if the sub-organization can view single and all executions

write

Sets if the sub-organization can fix executions

connector

Defines whether the sub-organization can create, read, update and remove connectors

create

Sets if the sub-organization can create new connectors

read

Sets if the sub-organization can view single and all connectors

write

Sets if the sub-organization can update connectors

delete

Sets if the sub-organization can delete connectors

tdm

Defines whether the sub-organization can create, read, update and remove target data models

create

Sets if the sub-organization can create new target data models

read

Sets if the sub-organization can view single and all target data models

write

Sets if the sub-organization can update target data models

delete

Sets if the sub-organization can delete target data models

Payload

{
  "name": "string",
  "identifier": "string",
  "permissions": {
    "pipeline": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "execution": {
      "create": true,
      "read": true,
      "write": true
    },
    "connector": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "tdm": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    }
  }
}

Response

Attributes

The ID of the user

name

The name of the sub-organization you want to add

identifier

The identifier to uniquely recognize sub-organizations

permissions

Defines per pipeline component whether the sub-organization is allowed to create, read, update and delete them using boolean values

pipeline

Define whether the sub-organization can create, read, update and remove pipelines

create

Sets if the sub-organization can create new pipelines

read

Sets if the sub-organization can view single and all pipelines

write

Sets if the sub-organization can update pipelines

delete

Sets if the sub-organization can delete pipelines

execution

Defines whether the sub-organization can create, read, and fix executions

create

Sets if the sub-organization can create new executions

read

Sets if the sub-organization can view single and all executions

write

Sets if the sub-organization can fix executions

connector

Define whether the sub-organization can create, read, update and remove connectors

create

Sets if the sub-organization can create new connectors

read

Sets if the sub-organization can view single and all connectors

write

Sets if the sub-organization can update connectors

delete

Sets if the sub-organization can delete connectors

tdm

Defines whether the sub-organization can create, read, update and remove target data models

create

Sets if the sub-organization can create new target data models

read

Sets if the sub-organization can view single and all target data models

write

Sets if the sub-organization can update target data models

delete

Sets if the sub-organization can delete target data models

created_at

The date and time when the sub-organization was first created

created_by

Information of whom created the sub-organization

The ID of the user who created the sub-organization

name

The name of the user who created the sub-organization

identifier

The identifier of the user who created the sub-organization

type

Defines the kind of user who created the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

updated_at

The date and time when the sub-organization was last updated

updated_by

Information of whom last updated the sub-organization

The ID of the user or sub-organization who last updated the sub-organization

name

The name of the user or sub-organization who last updated the sub-organization

identifier

The identifier of the user or sub-organization who last updated the sub-organization

type

Defines the kind of user who last updated the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "identifier": "string",
    "permissions": {
      "pipeline": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "execution": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "connector": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "tdm": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      }
    },
    "created_at": "2022-03-07 12:48:28.653",
      "created_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      },
    "updated_at": "2022-03-07 12:48:28.653",
    "updated_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      }
  }
}

Read by ID

Endpoint

GET /sub-organization/{id}

Response

Attributes

The ID of the user

name

The name of the sub-organization you want to add

identifier

The identifier to uniquely recognize sub-organizations

permissions

Defines per pipeline component whether the sub-organization is allowed to create, read, update and delete them using boolean values

pipeline

Define whether the sub-organization can create, read, update and remove pipelines

create

Sets if the sub-organization can create new pipelines

read

Sets if the sub-organization can view single and all pipelines

write

Sets if the sub-organization can update pipelines

delete

Sets if the sub-organization can delete pipelines

execution

Defines whether the sub-organization can create, read, and fix executions

create

Sets if the sub-organization can create new executions

read

Sets if the sub-organization can view single and all executions

write

Sets if the sub-organization can fix executions

connector

Defines whether the sub-organization can create, read, update and remove connectors

create

Sets if the sub-organization can create new connectors

read

Sets if the sub-organization can view single and all connectors

write

Sets if the sub-organization can update connectors

delete

Sets if the sub-organization can delete connectors

tdm

Defines whether the sub-organization can create, read, update and remove target data models

create

Sets if the sub-organization can create new target data models

read

Sets if the sub-organization can view single and all target data models

write

Sets if the sub-organization can update target data models

delete

Sets if the sub-organization can delete target data models

created_at

The date and time when the sub-organization was first created

created_by

User information of whom created the sub-organization

The ID of the user who created the sub-organization

name

The name of the user who created the sub-organization

identifier

The identifier of the user who created the sub-organization

type

Defines the kind of user who created the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

updated_at

The date and time when the sub-organization was last updated

updated_by

Information of whom last updated the sub-organization

The ID of the user who last updated the sub-organization

name

The name of the user who last updated the sub-organization

identifier

The identifier of the user who last updated the sub-organization

type

Defines the kind of user who last updated the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "identifier": "string",
    "permissions": {
      "pipeline": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "execution": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "connector": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "tdm": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      }
    },
    "created_at": "2022-03-07 12:48:28.653",
      "created_by": {
        "id": true,
        "name": true,
        "identifier": true,
        "type": "USER"
      },
    "updated_at": "2022-03-07 12:48:28.653",
    "updated_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      }
  }
}

Read all

To further refine the response you can use query parameters like sort, filters, pagination and options. Look at a more detailed explanation here.

Endpoint

GET /sub-organization/

Response

Attributes

The ID of the user

name

The name of the sub-organization you want to add

identifier

The identifier to uniquely recognize sub-organizations

created_at

The date and time when the sub-organization was first created

created_by

Information of whom created the sub-organization

The ID of the user who created the sub-organization

name

The name of the user or sub-organization who created the sub-organization

identifier

The identifier of the user or sub-organization who created the sub-organization

type

Defines the kind of user who created the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

updated_at

The date and time when the sub-organization was last updated

updated_by

Information of whom last updated the sub-organization

The ID of the user who last updated the sub-organization

name

The name of the user who last updated the sub-organization

identifier

The identifier of the user who last updated the sub-organization

type

Defines the kind of user who last updated the sub-organization:

USER: User of your organization
SUB_ORG: Sub-organization that is part of your organization

pagination

An object containing metadata about the result

total

The number of entries in the data array

offset

The offset set in the request parameters

limit

The limit set in the request parameters

Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "identifier": "string",
      "created_at": "2022-03-07 12:48:28.653",
        "created_by": {
          "id": "string",
          "name": "string",
          "identifier": "string",
          "type": "USER"
        },
      "updated_at": "2022-03-07 12:48:28.653",
      "updated_by": {
          "id": "string",
          "name": "string",
          "identifier": "string",
          "type": "USER"
        }
    }
  ],
  "pagination": {
    "total": 0,
    "offset": 0,
    "limit": 0
  }
}

Delete

Endpoint

DELETE /sub-organization/{id}

Response

Attributes

message

Message confirming the deletion of the sub-organization or providing an error message

Response

{
  "data": {
      "message": "string"
  }
}

Create​

Payload​

Response​

Update​

Payload​

Response​

Read by ID​

Response​

Read all​

Response​

Delete​

Response​

Create

Payload

Response

Update

Payload

Response

Read by ID

Response

Read all

Response

Delete

Response