Jump to

• Request
• Response
• Examples

Update a baseline

patch

/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Baselines/{BaselineId}

Request

Path Parameters

• BaselineId(required): integer(int64)
  Unique identifier of the baseline. Value is auto-generated.
• 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

• Description: string
  Title: Baseline Description

  Maximum Length: 1000

  Description of the baseline.
• Name: string
  Title: Baseline Name

  Maximum Length: 100

  Name of the baseline.
• PrimaryFlag: boolean
  Title: Primary Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether the baseline is the primary baseline.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Baseline Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the baseline.",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the baseline is the primary baseline.",
            "nullable":false,
            "default":false
        },
        "Name":{
            "title":"Baseline Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the baseline.",
            "nullable":false
        }
    }
}

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-Baselines-item-response

Type: object

Show Source

• BaselineId: integer (int64)
  Title: Baseline ID

  Read Only: true

  Unique identifier of the baseline. Value is auto-generated.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the baseline was taken. Value is defaulted to the current date when the baseline is created.
• Description: string
  Title: Baseline Description

  Maximum Length: 1000

  Description of the baseline.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Baseline Name

  Maximum Length: 100

  Name of the baseline.
• PrimaryFlag: boolean
  Title: Primary Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether the baseline is the primary baseline.

{
    "type":"object",
    "properties":{
        "BaselineId":{
            "title":"Baseline ID",
            "type":"integer",
            "description":"Unique identifier of the baseline. Value is auto-generated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the baseline was taken. Value is defaulted to the current date when the baseline is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "title":"Baseline Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the baseline.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the baseline is the primary baseline.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Baseline Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the baseline.",
            "nullable":false,
            "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 baseline 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/300100179567399/child/Baselines/300100179681923

Request Body Example

The following shows an example of the request body in JSON format.

{
    "Name": "NewBaselineName",
    "Description": "This is the updated baseline description"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "BaselineId": 300100179681923,
    "Name": "NewBaselineName",
    "Description": "This is the updated baseline description",
    "PrimaryFlag": true,
    "CreationDate": "2019-06-11T11:05:22+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100179567399/child/Baselines/300100179681923",
            "name": "Baselines",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100179567399/child/Baselines/300100179681923",
            "name": "Baselines",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100179567399",
            "name": "projectPlans",
            "kind": "item"
        }
    ]
}

Back to Top