Jump to

• Request
• Response

List Projects

get

[host-url]/dt-rest/v2/projects

Retrieves a list with all projects. This method supports various query parameters to filter and customize the response:

• name: filters projects by name
• fields: specifies the fields to include in the response (comma-separated)

The following examples demonstrate the supported query patterns:

• Retrieve all projects (no filters):

  Retrieves all available projects without any name filtering. All default fields for these projects will be included in the response.

  /projects


• Retrieve all projects with specific fields:

  Retrieves all available projects without any name filtering, and the response will only include the fields specified in the fields parameter.

  /projects?fields=name,projectId,...


• Retrieve a project by name:

  Retrieves a project that matches the given name. All default fields for this project will be included in the response.

  /projects?name=your_project_name


• Retrieve a project by name with specific fields:

  Retrieves a project that matches the given name, and the response will only include the fields specified in the fields parameter.

  /projects?name=your_project_name&fields=name,projectId,...

Request

Query Parameters

• fields: string
  comma-separated list of fields to include in the response
• name: string
  filters projects by name

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a response object containing the list of projects

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DTProjectDTO
  JSON representing a project.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DTProjectDTO"
    }
}

Nested Schema : DTProjectDTO

Type: object

JSON representing a project.

Show Source

• dateCreated: string (date-time)
• dateUpdated: string (date-time)
• firstUser: string
• name(required): string
• projectId: string

{
    "type":"object",
    "description":"JSON representing a project.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "projectId":{
            "type":"string"
        },
        "dateCreated":{
            "type":"string",
            "format":"date-time"
        },
        "dateUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "firstUser":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top