REST API Reference

REST API Reference

Projects

Projects

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

Resource URL

/tdm/v1/projects

HTTP Request

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

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 Query Parameters

The request includes the following optional query parameters:
Parameter
Description
name
Name of the project.
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 project ID 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?name=sk_doctest_api

Sample Response

[ { "id": 1, "name": "sk_doctest_api", "description": null, "createdByName": "Administrator", "creationDate": 1540793633747, "lastUpdatedDate": 1540793633747, "lastUpdatedByName": "Administrator", "status": "NEW", "folderName": "sk_doctest_api", "repositoryName": "PCREPO", "owner": "Administrator", "ownerNamespace": "Native" } ]

0 COMMENTS

We’d like to hear from you!