Jump to

• Request
• Response
• Examples

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CustomerTeamMembers: array Customer Team Members
  Title: Customer Team Members

  A customer team member is an external stakeholder from the client organization who is granted access to the project.
• 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.

{
    "type":"object",
    "properties":{
        "CustomerTeamMembers":{
            "title":"Customer Team Members",
            "type":"array",
            "description":"A customer team member is an external stakeholder from the client organization who is granted access to the project.",
            "items":{
                "$ref":"#/components/schemas/projects-ProjectCustomers-CustomerTeamMembers-item-post-request"
            }
        },
        "PartyId":{
            "title":"Customer Party ID",
            "type":"integer",
            "description":"Unique identifier of the project customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId",
                    "ProjectPartyId",
                    "ProjectPartyType"
                ]
            }
        },
        "PartyName":{
            "title":"Customer Party Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of a person or group of persons who constitute the project customer.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            }
        },
        "PartyNumber":{
            "title":"Customer Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique number of a person or group of persons who constitute the project customer.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            }
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProjectPartyId":{
            "title":"Project Party ID",
            "type":"integer",
            "description":"Unique identifier of a party assignment to the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Customer Team Members

Type: array

Title: Customer Team Members

A customer team member is an external stakeholder from the client organization who is granted access to the project.

Show Source

• Array of: object projects-ProjectCustomers-CustomerTeamMembers-item-post-request

{
    "title":"Customer Team Members",
    "type":"array",
    "description":"A customer team member is an external stakeholder from the client organization who is granted access to the project.",
    "items":{
        "$ref":"#/components/schemas/projects-ProjectCustomers-CustomerTeamMembers-item-post-request"
    }
}

Nested Schema : projects-ProjectCustomers-CustomerTeamMembers-item-post-request

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  Date on which the assignment of the customer team member to the project is scheduled to end.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person assigned as a customer team member on the project.
• ProjectPartyId: integer (int64)
  Title: Project Party ID

  Unique identifier of a party assignment to the project.
• ProjectRole: string
  Title: Name

  Maximum Length: 240

  The role that a customer team member performs on a project.
• ProjectRoleId: integer (int64)
  Title: Project Role ID

  The unique identifier of the project role.
• RegistryId: string
  Title: Registry ID

  Maximum Length: 30

  Alternate identifier of the person assigned as a customer team member on the project.
• StartDate: string (date)
  Title: Start Date

  Date from which the assignment of the customer team member to the project is scheduled to begin.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date on which the assignment of the customer team member to the project is scheduled to end.",
            "format":"date",
            "nullable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person assigned as a customer team member on the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId",
                    "ProjectPartyId",
                    "ProjectPartyType"
                ]
            }
        },
        "ProjectPartyId":{
            "title":"Project Party ID",
            "type":"integer",
            "description":"Unique identifier of a party assignment to the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProjectRole":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The role that a customer team member performs on a project.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProjectRoleId":{
            "title":"Project Role ID",
            "type":"integer",
            "description":"The unique identifier of the project role.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier of the person assigned as a customer team member on the project.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date from which the assignment of the customer team member to the project is scheduled to begin.",
            "format":"date",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : projects-ProjectCustomers-item-response

Type: object

Show Source

• CustomerTeamMembers: array Customer Team Members
  Title: Customer Team Members

  A customer team member is an external stakeholder from the client organization who is granted access to the project.
• 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.

{
    "type":"object",
    "properties":{
        "CustomerTeamMembers":{
            "title":"Customer Team Members",
            "type":"array",
            "description":"A customer team member is an external stakeholder from the client organization who is granted access to the project.",
            "items":{
                "$ref":"#/components/schemas/projects-ProjectCustomers-CustomerTeamMembers-item-response"
            }
        },
        "PartyId":{
            "title":"Customer Party ID",
            "type":"integer",
            "description":"Unique identifier of the project customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId",
                    "ProjectPartyId",
                    "ProjectPartyType"
                ]
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer Party Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of a person or group of persons who constitute the project customer.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Customer Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique number of a person or group of persons who constitute the project customer.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectPartyId":{
            "title":"Project Party ID",
            "type":"integer",
            "description":"Unique identifier of a party assignment to the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Customer Team Members

Type: array

Title: Customer Team Members

A customer team member is an external stakeholder from the client organization who is granted access to the project.

Show Source

• Array of: object projects-ProjectCustomers-CustomerTeamMembers-item-response

{
    "title":"Customer Team Members",
    "type":"array",
    "description":"A customer team member is an external stakeholder from the client organization who is granted access to the project.",
    "items":{
        "$ref":"#/components/schemas/projects-ProjectCustomers-CustomerTeamMembers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projects-ProjectCustomers-CustomerTeamMembers-item-response

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  Date on which the assignment of the customer team member to the project is scheduled to end.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Person: string
  Title: Person

  Read Only: true

  Maximum Length: 360

  The combination of title, first, middle, last, and suffix names of the person.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person assigned as a customer team member on the project.
• PrimaryEmail: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Primary email address of the person assigned as a customer team member on the project.
• PrimaryJobTitle: string
  Title: Primary Job Title

  Read Only: true

  Maximum Length: 100

  Primary job title of the person assigned as a customer team member on the project.
• PrimaryPhone: string
  Title: Primary Phone

  Read Only: true

  Primary phone number of the person assigned as a customer team member on the project.
• ProjectPartyId: integer (int64)
  Title: Project Party ID

  Unique identifier of a party assignment to the project.
• ProjectRole: string
  Title: Name

  Maximum Length: 240

  The role that a customer team member performs on a project.
• ProjectRoleId: integer (int64)
  Title: Project Role ID

  The unique identifier of the project role.
• RegistryId: string
  Title: Registry ID

  Maximum Length: 30

  Alternate identifier of the person assigned as a customer team member on the project.
• StartDate: string (date)
  Title: Start Date

  Date from which the assignment of the customer team member to the project is scheduled to begin.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date on which the assignment of the customer team member to the project is scheduled to end.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Person":{
            "title":"Person",
            "maxLength":360,
            "type":"string",
            "description":"The combination of title, first, middle, last, and suffix names of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person assigned as a customer team member on the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId",
                    "ProjectPartyId",
                    "ProjectPartyType"
                ]
            },
            "x-queryable":true
        },
        "PrimaryEmail":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"Primary email address of the person assigned as a customer team member on the project.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PrimaryJobTitle":{
            "title":"Primary Job Title",
            "maxLength":100,
            "type":"string",
            "description":"Primary job title of the person assigned as a customer team member on the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhone":{
            "title":"Primary Phone",
            "type":"string",
            "description":"Primary phone number of the person assigned as a customer team member on the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProjectPartyId":{
            "title":"Project Party ID",
            "type":"integer",
            "description":"Unique identifier of a party assignment to the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectRole":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The role that a customer team member performs on a project.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectRoleId":{
            "title":"Project Role ID",
            "type":"integer",
            "description":"The unique identifier of the project role.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier of the person assigned as a customer team member on the project.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date from which the assignment of the customer team member to the project is scheduled to begin.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CustomerTeamMembers

Operation: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectCustomers/{ProjectPartyId}/child/CustomerTeamMembers

Parameters:

• ProjectId: $request.path.ProjectId
• ProjectPartyId: $request.path.ProjectPartyId

A customer team member is an external stakeholder from the client organization who is granted access to the project.

Back to Top

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"
    ...
       }
}

Back to Top