Create a project classification
post
/fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectClassifications
Request
Path Parameters
-
projectTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Project Templates resource and used to uniquely identify an instance of Project Templates. The client should not generate the hash key value. Instead, the client should query on the Project Templates collection resource in order to navigate to a specific instance of Project Templates to get the hash key.
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
-
ClassCategory: string
Title:
Class Category
Maximum Length:240
Name of the project class category. Enter a value for either this attribute or Class Category ID but not both. -
ClassCategoryId: integer
(int64)
Title:
Class Category ID
Unique identifier of the project class category. Enter a value for either this attribute or Class Category but not both. -
ClassCode: string
Title:
Class Code
Maximum Length:240
Name of the project class code. Enter a value for either this attribute or Class Code ID but not both. -
ClassCodeId: integer
(int64)
Title:
Class Code ID
Unique identifier of the project class code. Enter a value for either this attribute or Class Code but not both. -
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 : projectTemplates-ProjectClassifications-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Class Category
Maximum Length:240
Name of the project class category. Enter a value for either this attribute or Class Category ID but not both. -
ClassCategoryId: integer
(int64)
Title:
Class Category ID
Unique identifier of the project class category. Enter a value for either this attribute or Class Category but not both. -
ClassCode: string
Title:
Class Code
Maximum Length:240
Name of the project class code. Enter a value for either this attribute or Class Code ID but not both. -
ClassCodeId: integer
(int64)
Title:
Class Code ID
Unique identifier of the project class code. Enter a value for either this attribute or Class Code but not both. -
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectClassificationId: integer
(int64)
Title:
Project Classification ID
Read Only:true
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 create a project classification 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/projectTemplates/99999/child/ProjectClassifications
Request Body Example
The following shows an example of the request body in JSON format.
{ "ClassCategory" : "Funding Source", "ClassCode" : "State or Local" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ProjectClassificationId": 300100183573644, "ClassCategoryId": 10000, "ClassCategory": "Funding Source", "ClassCodeId": 2, "ClassCode": "State or Local", "CodePercentage": 0, "CreatedBy": "Connor.Horton", "CreationDate": "2019-11-29T10:43:27+00:00", "LastUpdatedBy": "Connor.Horton", "LastUpdateDate": "2019-11-29T10:43:28.649+00:00", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/100000010074004/child/ProjectClassifications/300100183573644", "name": "ProjectClassifications", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/100000010074004/child/ProjectClassifications/300100183573644", "name": "ProjectClassifications", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/100000010074004", "name": "projectTemplates", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/100000010074004/child/ProjectClassifications/300100183573644/lov/ClassCategoryProjectTypeVVO1", "name": "ClassCategoryProjectTypeVVO1", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/100000010074004/child/ProjectClassifications/300100183573644/lov/ClassCodePUVVO1", "name": "ClassCodePUVVO1", "kind": "collection" } ] }