Jump to

• Request
• Response

View a Project Dependency

get

/api/restapi/projectDependency/{projectDependencyId}

This endpoint returns a project dependency that meet the following requirements:

• The object has an ID that matches the value of the {projectDependencyId} path parameter.

Request

Path Parameters

• projectDependencyId(required): integer(int64)
  ID of the Project Dependency to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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.

• projectDependencyId
• projectId,dependentProjectId
• projectId,dependentProjectCode,dependentProjectWorkspaceCode
• projectCode,projectWorkspaceCode,dependentProjectId
• projectCode,projectWorkspaceCode,dependentProjectCode,dependentProjectWorkspaceCode

Show Source

• 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.

{
    "title":"ApiEntityProjectDependency",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dependencyDescription":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"The detailed summary of the project dependency. <br />The description provides more information than short names or titles. <br />It can give background information or establish a purpose for the item. <br />Dependency Descriptions can help elaborate the reasons for the project dependency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectDependencyId":{
            "type":"integer",
            "description":"The unique identifier of a project dependency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dependentProjectId":{
            "type":"integer",
            "description":"The unique identifier of a project that has other projects that it relies on for support.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dependentProjectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The project code of a project that has other projects that it relies on for support.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The workspace code of a project that has other projects depending on it.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dependentProjectWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The workspace code of a project that has other projects that it relies on for support.#project invalid inputs",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project that has other projects depending on it.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The project code of a project that has other projects depending on it.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProjectDependency object, a unique ProjectDependency object can be identified by the following combinations of the fields.<ul><li>projectDependencyId</li><li>projectId,dependentProjectId</li><li>projectId,dependentProjectCode,dependentProjectWorkspaceCode</li><li>projectCode,projectWorkspaceCode,dependentProjectId</li><li>projectCode,projectWorkspaceCode,dependentProjectCode,dependentProjectWorkspaceCode</li>",
    "exampleSetFlag":false
}

404 Response

The requested project dependency does not exist, or you do not have access to it.

Back to Top