Sign in
latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Project Management

Get Project Details

Retrieves the information associated with a Project.

Permission Required: Read Project Properties

get/v2.0/public/projects/{projectId}

Path parameters

projectIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

Project ID.

Response

Returns project details.

projectIdstring uuid

Project ID.

projectNamestring nullable

Name of the project.

dateTimeCreatedstring date-time

Date and time when the project was created in UTC format.

desiredDeliveryDatestring date-time nullable

Desired delivery date and time for new project in UTC format.

statusstring nullable

The project's current status.

metatagsobject nullable

Metatags provide for the ability to assign metadata to projects in the form of key-value pairs. Although there are no inherent types of metatags, they enable customers to categorize a project by purpose, owner, environment, or other criteria for administrative purposes. Defined.ai does not perform any actions on metatags that customers submit.

The root-level properties support string, object, and array data types (data types do not belong to these three will be converted to string type), while properties at inner level support all valid JSON data types.

Below is an example of a set of metatags:

{ 
    "rootString":  "This is a string",
    "rootObject":  {
		"innerBoolean": true,
		"innerNumber": 1,
		"innerString": "This is another string",
		"innerNull": null,
		"innerObject": {
			},
		"innerArray": []
	},
    "rootArray": [1, 2, 3, 4]
}

Example response

{
  "projectId": "00000000-0000-0000-0000-000000000000"
}