Create a task dependency
post
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/TaskDependencies
Request
Path Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DependencyId: integer
(int64)
Title:
Dependency ID
Identifier of the dependency that exists between tasks. -
DependencyType: string
Title:
Dependency Type
Maximum Length:30
Default Value:fs
The type of dependency that exists between tasks. -
ExternalPredecessorTaskId: string
Title:
External Predecessor Task ID
Unique identifier of the predecessor project task that is created in the third-party application. -
ExternalTaskId: string
Title:
External Task ID
Identifier of the project task that is created in the third-party application. -
Lag: number
Title:
Lag
Default Value:0
Number of days that exist between tasks before the dependency is activated. -
PredecessorTaskNumber: string
Title:
Predecessor Task Number
Number of the task which is a predecessor to another task. -
TaskNumber: string
Title:
Task Number
The number of a task.
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 : projects-TaskDependencies-item-response
Type:
Show Source
object
-
DependencyId: integer
(int64)
Title:
Dependency ID
Identifier of the dependency that exists between tasks. -
DependencyType: string
Title:
Dependency Type
Maximum Length:30
Default Value:fs
The type of dependency that exists between tasks. -
ExternalPredecessorTaskId: string
Title:
External Predecessor Task ID
Unique identifier of the predecessor project task that is created in the third-party application. -
ExternalTaskId: string
Title:
External Task ID
Identifier of the project task that is created in the third-party application. -
Lag: number
Title:
Lag
Default Value:0
Number of days that exist between tasks before the dependency is activated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PredecessorTaskId: integer
(int64)
Title:
Predecessor Task ID
Read Only:true
Unique identifier of the predecessor project element. -
PredecessorTaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name of the predecessor task. -
PredecessorTaskNumber: string
Title:
Predecessor Task Number
Number of the task which is a predecessor to another task. -
ProjectId: integer
(int64)
Title:
Project ID
Read Only:true
Identifier of the project with which the element is associated. -
TaskId: integer
(int64)
Title:
Task ID
Read Only:true
The unique identifier of the project element. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name of the task. -
TaskNumber: string
Title:
Task Number
The number of a task.
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 create a project task dependency by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100125163003/child/TaskDependencies
Example of Request Body
The following example shows the request body to create a new task dependency that is associated to the project with project ID 300100125163003.
{ "ExternalPredecessorTaskId": "1.02", "ExternalTaskId": "1.01", "Lag": 5, "DependencyType": "fs" }
Example of Response Body
The following example shows the contents of the response body in JSON format, including the details of the new task dependency.
{ "DependencyId": 300100125161048, "ProjectId": 300100125163003, "PredecessorTaskName": "Task 2", "ExternalPredecessorTaskId": "1.02", "PredecessorTaskNumber": "1.02", "PredecessorTaskId": 300100125163014, "TaskName": "Task 1", "ExternalTaskId": "1.01", "TaskNumber": "1.01", "TaskId": 300100125163011, "Lag": 5, "DependencyType": "fs" }