Jump to

• Request
• Response
• Examples

Create a provider business unit for a project template

post

/fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProviderBusinessUnits

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Identifier of the business unit associated with the project template to which the provider business unit has been assigned.
• BusinessUnitName: string
  Maximum Length: 255

  Name of the business unit associated with the project template to which the provider business unit has been assigned.

{
    "type":"object",
    "properties":{
        "BusinessUnitName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the business unit associated with the project template to which the provider business unit has been assigned.",
            "nullable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Identifier of the business unit associated with the project template to which the provider business unit has been assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

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 : projectTemplates-ProviderBusinessUnits-item-response

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Identifier of the business unit associated with the project template to which the provider business unit has been assigned.
• BusinessUnitName: string
  Maximum Length: 255

  Name of the business unit associated with the project template to which the provider business unit has been assigned.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of user who created the provider business unit for this project template.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the provider business unit was created for the project template.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date on which the provider business unit was last updated for the project template.
• LastUpdatedDate: string (date-time)
  Read Only: true

  Name of user who last updated the provider business unit for this project template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date on which the provider business unit was last updated for the project template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"Name of user who last updated the provider business unit for this project template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the provider business unit was created for the project template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of user who created the provider business unit for this project template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Identifier of the business unit associated with the project template to which the provider business unit has been assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the business unit associated with the project template to which the provider business unit has been assigned.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

Back to Top

Examples

The following example shows how to create a provider business unit for a project template 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/<ProjectTemplateId>/child/ProviderBusinessUnits"

Example of Request Body

The following example shows the request body to create a provider business unit for a project template.

{
    "BusinessUnitName":"Vision Germany"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "BusinessUnitId": 911,
    "BusinessUnitName": "Vision Germany",
    "CreatedBy": "Devon.Smith",
    "CreationDate": "2022-10-21T04:42:09+00:00",
    "LastUpdatedBy": "Devon.Smith",
    "LastUpdatedDate": "2022-10-21T04:42:09+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/300100007490613/child/ProviderBusinessUnits/911",
            "name": "ProviderBusinessUnits",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/300100007490613/child/ProviderBusinessUnits/911",
            "name": "ProviderBusinessUnits",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/300100007490613",
            "name": "projectTemplates",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/300100007490613/child/ProviderBusinessUnits/911/lov/BusinessUnitsVA",
            "name": "BusinessUnitsVA",
            "kind": "collection"
        }
    ]
}

Back to Top