Jump to

• Request
• Response
• Examples

Update a task dependency

patch

/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/TaskDependencies/{DependencyId}

Request

Path Parameters

• DependencyId(required): integer(int64)
  Identifier of the dependency that exists between tasks.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PredecessorTaskNumber":{
            "title":"Predecessor Task Number",
            "type":"string",
            "description":"Number of the task which is a predecessor to another task.",
            "nullable":true
        },
        "Lag":{
            "title":"Lag",
            "type":"number",
            "description":"Number of days that exist between tasks before the dependency is activated.",
            "nullable":true,
            "default":"0"
        },
        "ExternalTaskId":{
            "title":"External Task ID",
            "type":"string",
            "description":"Identifier of the project task that is created in the third-party application.",
            "nullable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "type":"string",
            "description":"The number of a task.",
            "nullable":true
        },
        "DependencyType":{
            "title":"Dependency Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of dependency that exists between tasks.",
            "nullable":true,
            "default":"fs"
        },
        "ExternalPredecessorTaskId":{
            "title":"External Predecessor Task ID",
            "type":"string",
            "description":"Unique identifier of the predecessor project task that is created in the third-party application.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : projects-TaskDependencies-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"The unique identifier of the project element.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PredecessorTaskNumber":{
            "title":"Predecessor Task Number",
            "type":"string",
            "description":"Number of the task which is a predecessor to another task.",
            "nullable":true,
            "x-queryable":true
        },
        "PredecessorTaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the predecessor task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project with which the element is associated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "type":"string",
            "description":"The number of a task.",
            "nullable":true,
            "x-queryable":true
        },
        "PredecessorTaskId":{
            "title":"Predecessor Task ID",
            "type":"integer",
            "description":"Unique identifier of the predecessor project element.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Lag":{
            "title":"Lag",
            "type":"number",
            "description":"Number of days that exist between tasks before the dependency is activated.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "DependencyId":{
            "title":"Dependency ID",
            "type":"integer",
            "description":"Identifier of the dependency that exists between tasks.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalTaskId":{
            "title":"External Task ID",
            "type":"string",
            "description":"Identifier of the project task that is created in the third-party application.",
            "nullable":true,
            "x-queryable":true
        },
        "DependencyType":{
            "title":"Dependency Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of dependency that exists between tasks.",
            "nullable":true,
            "default":"fs",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalPredecessorTaskId":{
            "title":"External Predecessor Task ID",
            "type":"string",
            "description":"Unique identifier of the predecessor project task that is created in the third-party application.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to update a project task dependency 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/projects/300100072576989/child/TaskDependencies/300100125161048

Example of Request Body

The following example shows the request body to update the lag and dependency type of the project task dependency with dependency ID 300100125161048 that belongs to the project with project ID 300100072576989.

{
    "Lag": 3,
    "DependencyType": "ff"
}

Example of Response Body

The following example shows the contents of the response body in JSON format, including the updated billable property and task description.

 {
    "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": 3,
    "DependencyType": "ff"
}

Back to Top