Create department

POST 
/api/v1/teams/departments

Create department

Request

application/json

Body

required

departmentTag stringrequired

Unique identifier for the department, which is used for API operations

description string

members

object[]

required

Array [

description string

email stringrequired

name stringrequired

notificationsEnabled boolean

role string

]

name stringrequired

Responses

200

Successfully created a department

application/json

Schema

Schema

catalogEntityTag stringrequired
departmentTag stringrequired
description string
id stringrequired

members

object[]

required

Array [

description string

email stringrequired

name stringrequired

role

object

tag stringrequired

type stringrequired

]

name stringrequired

Example (from schema)

{
  "catalogEntityTag": "string",
  "departmentTag": "string",
  "description": "string",
  "id": "string",
  "members": [
    {
      "description": "string",
      "email": "string",
      "name": "string",
      "role": {
        "tag": "string",
        "type": "string"
      }
    }
  ],
  "name": "string"
}

400

Bad Request

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...