Update a project classification
patch
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectClassifications/{ProjectClassificationId}
Request
Path Parameters
-
ProjectClassificationId(required): integer(int64)
Unique identifier of the project classification.
-
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
Root Schema : schema
Type:
Show Source
object
-
ClassCategory: string
Title:
Class Category
Maximum Length:240
Name of the project class category. -
ClassCategoryId: integer
(int64)
Title:
Class Category ID
Unique identifier of the project class category. -
ClassCode: string
Title:
Class Code
Maximum Length:240
Name of the project class code. -
ClassCodeId: integer
(int64)
Title:
Class Code ID
Unique identifier of the project class code. -
CodePercentage: number
Title:
Code Percentage
Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100.
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-ProjectClassifications-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Class Category
Maximum Length:240
Name of the project class category. -
ClassCategoryId: integer
(int64)
Title:
Class Category ID
Unique identifier of the project class category. -
ClassCode: string
Title:
Class Code
Maximum Length:240
Name of the project class code. -
ClassCodeId: integer
(int64)
Title:
Class Code ID
Unique identifier of the project class code. -
CodePercentage: number
Title:
Code Percentage
Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectClassificationId: integer
(int64)
Title:
Project Classification ID
Unique identifier of the project classification.
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 update a project classification 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/300100010654938/child/ProjectClassifications/300100124638318
Request Body Example
The following shows an example of the request body in JSON format.
{ "CodePercentage":"12.3512" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ProjectClassificationId": 300100124638318, "ClassCategoryId": 10000, "ClassCategory": "Funding Source", "ClassCodeId": 2, "ClassCode": "State or Local", "CodePercentage": 12.351, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projects/300100010654938/child/ProjectClassifications/300100124638318", "name": "ProjectClassifications", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projects/300100010654938/child/ProjectClassifications/300100124638318", "name": "ProjectClassifications", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projects/300100010654938", "name": "projects", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projects/300100010654938/child/ProjectClassifications/300100124638318/lov/ClassCategoryProjectTypeVVO1", "name": "ClassCategoryProjectTypeVVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projects/300100010654938/child/ProjectClassifications/300100124638318/lov/ClassCodePUVVO1", "name": "ClassCodePUVVO1", "kind": "collection" } ] }