Skip to main content
API docs by Redocly

Organization Projects (0.0.19)

Download OpenAPI specification:Download

Organization

Page of organizations Deprecated

Page of all the organizations of the authorized requester

Authorizations:
ApplicationToken
query Parameters
resourceId
string
Default: ""

The resourceId of the project that you want to return

all
boolean
Default: false

Whether to return all or filter based on other query parameters

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "OrganizationPage"
}

Create organization Deprecated

Create new organization

Authorizations:
ApplicationToken
query Parameters
assignAuthenticatedUser
boolean
Default: true

Flag to assign the authenticated user to the new organization

Request Body schema: application/json
id
integer <int64>
name
string
organizationID
string
resourceId
string
resourceUUID
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organizationID": "string",
  • "resourceId": "string",
  • "resourceUUID": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organizationID": "string",
  • "resourceId": "string",
  • "resourceUUID": "string"
}

Delete organization Deprecated

Delete an organization by its Id

Authorizations:
ApplicationToken
path Parameters
organizationId
required
string

The id of the organization that you want to perform the action on

Responses

Get organization Deprecated

Get an organization by its Id

Authorizations:
ApplicationToken
path Parameters
organizationId
required
string

The id of the organization that you want to perform the action on

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organizationID": "string",
  • "resourceId": "string",
  • "resourceUUID": "string"
}

Retrieve organization image Deprecated

Retrieve organization image as base 64 text

Authorizations:
ApplicationToken
path Parameters
organizationId
required
string

The id of the organization that you want to perform the action on

Responses

Set organization image Deprecated

Set organization image

Authorizations:
ApplicationToken
path Parameters
organizationId
required
string

The id of the organization that you want to perform the action on

Request Body schema: application/json
data
string
format
string

Responses

Request samples

Content type
application/json
{
  • "data": "string",
  • "format": "string"
}

Project

Page of projects in organization Deprecated

Page of all the projects of the authorized requester in specified organization

Authorizations:
ApplicationToken
query Parameters
organization
required
string

Retrieve all the projects from the organization with organizationID.

resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "ProjectPage"
}

Create project in organization Deprecated

Create new project in an organization

Authorizations:
ApplicationToken
Request Body schema: application/json
id
integer <int64>
name
string
object (Organization)
projectID
string
resourceId
string
resourceUUID
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organization": {
    },
  • "projectID": "string",
  • "resourceId": "string",
  • "resourceUUID": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organization": {
    },
  • "projectID": "string",
  • "resourceId": "string",
  • "resourceUUID": "string"
}

Delete Project Deprecated

Authorizations:
ApplicationToken
path Parameters
projectId
required
string

The id of the project that you want to perform the action on

Responses

Get project Deprecated

Get a project by its ID

Authorizations:
ApplicationToken
path Parameters
projectId
required
string

The id of the project that you want to perform the action on

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organization": {
    },
  • "projectID": "string",
  • "resourceId": "string",
  • "resourceUUID": "string"
}