Jump to

• Request
• Response
• Examples

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

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

{
    "type":"object",
    "properties":{
        "DependencyType":{
            "title":"Dependency Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"fs"
        },
        "Lag":{
            "title":"Lag",
            "type":"number",
            "description":"Number of days that exist between project elements before the dependency is activated. Default value is 0 if not provided when using POST.",
            "nullable":true,
            "default":0
        },
        "PredecessorTaskId":{
            "title":"Predecessor Task ID",
            "type":"integer",
            "description":"Unique identifier of the predecessor project element. Value is mandatory when using POST.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IntegrationSource":{
            "title":"Integration Source",
            "type":"string",
            "description":"Indicates the task was created in a third-party application.",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessorTaskId":{
            "title":"Successor Task ID",
            "type":"integer",
            "description":"Unique identifier of the successor project element. Value is mandatory when using POST.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : projectPlans-TaskDependencies-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "Lag":{
            "title":"Lag",
            "type":"number",
            "description":"Number of days that exist between project elements before the dependency is activated. Default value is 0 if not provided when using POST.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "DependencyId":{
            "title":"Dependency ID",
            "type":"integer",
            "description":"Identifier of the dependency that exists between two tasks. Value is auto-generated when using POST and mandatory when using PATCH.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SuccessorTaskId":{
            "title":"Successor Task ID",
            "type":"integer",
            "description":"Unique identifier of the successor project element. Value is mandatory when using POST.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DependencyType":{
            "title":"Dependency Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "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"
            }
        },
        "PredecessorTaskId":{
            "title":"Predecessor Task ID",
            "type":"integer",
            "description":"Unique identifier of the predecessor project element. Value is mandatory when using POST.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntegrationSource":{
            "title":"Integration Source",
            "type":"string",
            "description":"Indicates the task was created in a third-party application.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 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"
}

Back to Top