Update a dependency between two tasks of a project
patch
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDependencies/{DependencyId}
Request
Path Parameters
-
DependencyId(required): integer(int64)
Identifier of the dependency that exists between two tasks. Value is auto-generated when using POST and mandatory when using PATCH.
-
ProjectId(required): integer(int64)
Unique identifier of the project.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DependencyType: string
Title:
Dependency Type
Maximum Length:30
Default Value:fs
The type of dependency that exists between project elements. Valid values are fs, if, sash, sf. Default value is fs if not provided when using POST. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
Lag: number
Title:
Lag
Default Value:0
Number of days that exist between project elements before the dependency is activated. Default value is 0 if not provided when using POST. -
PredecessorTaskId: integer
(int64)
Title:
Predecessor Task ID
Unique identifier of the predecessor project element. Value is mandatory when using POST. -
SuccessorTaskId: integer
(int64)
Title:
Successor Task ID
Unique identifier of the successor project element. Value is mandatory when using POST.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectPlans-TaskDependencies-item-response
Type:
Show Source
object
-
DependencyId: integer
(int64)
Title:
Dependency ID
Read Only:true
Identifier of the dependency that exists between two tasks. Value is auto-generated when using POST and mandatory when using PATCH. -
DependencyType: string
Title:
Dependency Type
Maximum Length:30
Default Value:fs
The type of dependency that exists between project elements. Valid values are fs, if, sash, sf. Default value is fs if not provided when using POST. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
Lag: number
Title:
Lag
Default Value:0
Number of days that exist between project elements before the dependency is activated. Default value is 0 if not provided when using POST. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PredecessorTaskId: integer
(int64)
Title:
Predecessor Task ID
Unique identifier of the predecessor project element. Value is mandatory when using POST. -
SuccessorTaskId: integer
(int64)
Title:
Successor Task ID
Unique identifier of the successor project element. Value is mandatory when using POST.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to update a dependency between two tasks by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100071625059/child/TaskDependencies/
Request Body Example
The following shows an example of the request body in JSON format.
{ "DependencyType" : "ff", "Lag" : 2 }
Response Body Example
The following shows an example of the response body in JSON format.
{ "DependencyId" : 300100169228615, "DependencyType" : "ff", "Lag" : 2, "PredecessorTaskId" : 300100071849086, "SuccessorTaskId" : 300100071849089, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/11.13.18.05/projectPlans/300100071625059/child/TaskDependencies/300100169228615", "name" : "TaskDependencies", "kind" : "item" }