View a Project Dependency by Codes
get
/api/restapi/projectDependency/itemCode
Send a request to this endpoint to view a project dependency with codes matching the code fields in query parameters.
Request
Query Parameters
-
dependentProjectCode(required): string
The project code of a project that has other projects that it relies on for support.
This is a required field. -
dependentProjectWorkspaceCode(required): string
The workspace code of a project that has other projects that it relies on for support.
This is a required field. -
projectCode(required): string
The project code of a project that has other projects depending on it.
This is a required field. -
projectWorkspaceCode(required): string
The workspace code of a project that has other projects depending on it.
This is a required field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityProjectDependency
Type:
object
Title:
ApiEntityProjectDependency
This entity represents a ProjectDependency object, a unique ProjectDependency object can be identified by the following combinations of the fields.
Show Source
- projectDependencyId
- projectId,dependentProjectId
- projectId,dependentProjectCode,dependentProjectWorkspaceCode
- projectCode,projectWorkspaceCode,dependentProjectId
- projectCode,projectWorkspaceCode,dependentProjectCode,dependentProjectWorkspaceCode
-
dependencyDescription: string
Minimum Length:
0
Maximum Length:4000
The detailed summary of the project dependency.
The description provides more information than short names or titles.
It can give background information or establish a purpose for the item.
Dependency Descriptions can help elaborate the reasons for the project dependency. -
dependentProjectCode: string
Minimum Length:
1
Maximum Length:60
The project code of a project that has other projects that it relies on for support. -
dependentProjectId: integer
(int64)
The unique identifier of a project that has other projects that it relies on for support.
-
dependentProjectWorkspaceCode: string
Minimum Length:
0
Maximum Length:60
The workspace code of a project that has other projects that it relies on for support.#project invalid inputs -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The project code of a project that has other projects depending on it. -
projectDependencyId: integer
(int64)
The unique identifier of a project dependency.
-
projectId: integer
(int64)
The unique identifier of a project that has other projects depending on it.
-
projectWorkspaceCode: string
Minimum Length:
0
Maximum Length:60
The workspace code of a project that has other projects depending on it. -
updateDate: string
(date-time)
Date when the record was last updated.
404 Response
The requested object does not exist, or you do not have access to it.