Create a baseline
post
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Baselines
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
-
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.
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-Baselines-item-response
Type:
Show Source
object
-
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.
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 baseline 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/projectPlans/{ProjectId}/child/Baselines
Request Body Example
The following shows an example of the request body in JSON format.
{ "Name": "Baseline3", "Description": "This is the new primary baseline.", "PrimaryFlag": true }
Response Body Example
The following shows an example of the response body in JSON format.
{ "BaselineId": 300100179681923, "Name": "Baseline3", "Description": "This is the new primary baseline.", "PrimaryFlag": true, "CreationDate": "2019-06-12T09:24:53.001+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectPlans/300100179567399/child/Baselines/300100179681923", "name": "Baselines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectPlans/300100179567399/child/Baselines/300100179681923", "name": "Baselines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectPlans/300100179567399", "name": "projectPlans", "kind": "item" } ] }