REST API Reference

10.5.1
- 10.5.3
- 10.5.2
- 10.5
- 10.4.1
- 10.4.0

Back Next

Plans

The plans request lists all plans in a project. If you include query parameters in the request, it returns plans that match the query parameters.

Resource URL

/tdm/v1/projects/{projectID}/plans

HTTP Request

GET http(s)://<host>:<port>/api/public/tdm/v1/projects/<project ID>/plans

Request Header

The request header includes the following headers:

Header	Description
accept	Use the following value: application/json
Authorization	Required. Use the following value: Basic <user name>

Request Path Parameters

The request includes the following path parameter:

Parameter	Description
projectId	Required. ID of the project that contains the plans.

Request Query Parameters

The request includes the following query parameters:

Parameter	Description
name	Name of the plan.
filter	Filters based on criteria.
sort	Sorts based on criteria. You can enter more than one field name as criteria. By default, sorts in ascending order of criteria. For example, to sort based on plan IDs in descending order, enter: id:desc
start	The start index of the list.
size	The number of records that you want to return.

Sample Request

GET http://<host>:6605/api/public/tdm/v1/projects/2/plans?name=TEST_123

Sample Response

[
  {
    "id": 2,
    "name": "TEST_123",
    "description": null,
    "createdByName": "Administrator",
    "creationDate": 1540976328110,
    "lastUpdatedDate": 1540976328110,
    "lastUpdatedByName": "Administrator",
    "statusType": "LOAD_SUCCESSFUL"
  }
]

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Plans

Plans

Resource URL

HTTP Request

Request Header

Request Path Parameters

Request Query Parameters

Sample Request

Sample Response