Create a project customer
post
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectCustomers
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
PartyId: integer
(int64)
Title:
Customer Party ID
Unique identifier of the project customer party. -
PartyName: string
Title:
Customer Party Name
Maximum Length:360
Name of a person or group of persons who constitute the project customer. -
PartyNumber: string
Title:
Customer Party Number
Maximum Length:30
Unique number of a person or group of persons who constitute the project customer. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the project. -
ProjectPartyId: integer
(int64)
Title:
Project Party ID
Unique identifier of a party assignment to the project.
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-ProjectCustomers-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Customer Party ID
Unique identifier of the project customer party. -
PartyName: string
Title:
Customer Party Name
Maximum Length:360
Name of a person or group of persons who constitute the project customer. -
PartyNumber: string
Title:
Customer Party Number
Maximum Length:30
Unique number of a person or group of persons who constitute the project customer. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the project. -
ProjectPartyId: integer
(int64)
Title:
Project Party ID
Unique identifier of a party assignment to the project.
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 customer by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json C:\CONTENT\REST_API\PPM\R11\Examples\op-projects-post.xml https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projects/300100072711280/child/ProjectCustomers
Example of Request Body
The following example shows the request body to create a project customer with party number 1005 associated with the project with project ID 300100072711280.
{ "PartyNumber": "1005" }
Example of Response Body
The following example shows the contents of the response body in JSON format, including the details of the new project customer.
{ "PartyId": 1005 "PartyNumber": null "PartyName": null "ProjectId": 300100072711280 "ProjectPartyId": 300100072928720 -"links": [3] -0: { "rel": "self" ... } }