Create a project expense resource
post
/fscmRestApi/resources/11.13.18.05/projectExpenseResources
Request
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
-
ExpenseAmount: number
Title:
Expense Amount
Amount allocated in the project for the expense resource. -
Name: string
Title:
Name
Maximum Length:240
Display name of the resource. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the project associated with the resource assignment. To identify the project, provide a value only for this attribute, or any one of the Project Number or the Project Name attribute. Project is mandatory when creating an assignment. -
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Alphanumeric identifier of the project. -
ResourceId: integer
(int64)
Title:
Resource ID
Unique identifier of the project enterprise resource.
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 : projectExpenseResources-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates the resource who created the row of data. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the row of data was created. -
ExpenseAmount: number
Title:
Expense Amount
Amount allocated in the project for the expense resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last edited. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates who last edited the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:240
Display name of the resource. -
ProjectCurrencyCode: string
Title:
Project Currency Code
Read Only:true
Maximum Length:15
Default Value:USD
The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the project associated with the resource assignment. To identify the project, provide a value only for this attribute, or any one of the Project Number or the Project Name attribute. Project is mandatory when creating an assignment. -
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Alphanumeric identifier of the project. -
ProjResourceId: integer
(int64)
Title:
Project Resource ID
Read Only:true
Unique identifier of the project resource. -
ResourceId: integer
(int64)
Title:
Resource ID
Unique identifier of the project enterprise resource.
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 expense resource 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/projectExpenseResources
Request Body Example
The following shows an example of the request body in JSON format.
{ "Name" : "Construction", "ProjectId" : "300100185240389", "ExpenseAmount" : "1500" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ProjResourceId": 300100211649582, "ProjectId": 300100211613856, "ResourceId": 300100033414520, "Name": "Construction", "ExpenseAmount": 1500, "CreatedBy": "Carlton.Baugh", "CreationDate": "2020-12-09T06:43:45+00:00", "LastUpdatedBy": "Carlton.Baugh", "LastUpdateDate": "2020-12-09T06:43:45.335+00:00", "ProjectCurrencyCode": "USD", "ProjectName": "test 1207 1124", "ProjectNumber": "test 1207 1124", "links": -0: { "rel": "self" ... } }