Jump to

• Request
• Response

Update a Project Dependency

put

/api/restapi/projectDependency

Send a request to this endpoint to update a project dependency. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityProjectDependencyInput

Type: object

Title: ApiEntityProjectDependencyInput

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(required): 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)
  Read Only: true

  Deprecated. As of 24.5.
  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(required): 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)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.

{
    "title":"ApiEntityProjectDependencyInput",
    "required":[
        "dependentProjectId",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        }
    },
    "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
}

Examples

Select an example Update a Project Dependency Using the Project Dependency ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input.

Back to Top