Get Project

GET 
/projects/:id

Get Project

Request

Path Parameters

id stringrequired

unique identifier of the project

Query Parameters

api-version string
The requested API version
Default value: 1.0

Responses

200

Success

text/plain

Schema

Schema

metadata

object

idstringnullable

Project id

namestringnullable

Project name

tagsstring[]nullable

Project tag list

createdBystringnullable

Id of the user who created the project

creationDatedate-timenullable

Creation date

properties

object

descriptionstringnullable

Optional description of the project

defaultboolean

Indicates if it's the default project

resourcesNumberint64

Number of resources created within the project

Example (from schema)

{
  "metadata": {
    "id": "string",
    "name": "string",
    "tags": [
      "string"
    ],
    "createdBy": "string",
    "creationDate": "2024-07-29T15:51:28.071Z"
  },
  "properties": {
    "description": "string",
    "default": true,
    "resourcesNumber": 0
  }
}

application/json

Schema

Schema

metadata

object

idstringnullable

Project id

namestringnullable

Project name

tagsstring[]nullable

Project tag list

createdBystringnullable

Id of the user who created the project

creationDatedate-timenullable

Creation date

properties

object

descriptionstringnullable

Optional description of the project

defaultboolean

Indicates if it's the default project

resourcesNumberint64

Number of resources created within the project

Example (from schema)

{
  "metadata": {
    "id": "string",
    "name": "string",
    "tags": [
      "string"
    ],
    "createdBy": "string",
    "creationDate": "2024-07-29T15:51:28.071Z"
  },
  "properties": {
    "description": "string",
    "default": true,
    "resourcesNumber": 0
  }
}

text/json

Schema

Schema

metadata

object

idstringnullable

Project id

namestringnullable

Project name

tagsstring[]nullable

Project tag list

createdBystringnullable

Id of the user who created the project

creationDatedate-timenullable

Creation date

properties

object

descriptionstringnullable

Optional description of the project

defaultboolean

Indicates if it's the default project

resourcesNumberint64

Number of resources created within the project

Example (from schema)

{
  "metadata": {
    "id": "string",
    "name": "string",
    "tags": [
      "string"
    ],
    "createdBy": "string",
    "creationDate": "2024-07-29T15:51:28.071Z"
  },
  "properties": {
    "description": "string",
    "default": true,
    "resourcesNumber": 0
  }
}

404

Not Found

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

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

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

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

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

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

500

Server Error