Jump to

• Request
• Response
• Examples

Create a project enterprise expense resource

post

/fscmRestApi/resources/11.13.18.05/projectEnterpriseExpenseResources

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 2000

  Additional details about the project enterprise expense resource.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type ID

  Name of the expenditure type of the project enterprise expense resource. Mandatory for POST operation if the resource is created from an expenditure type.
• ExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  Name of the expenditure type from which the project enterprise expense resource was created.
• ExternalId: string
  Title: External ID

  Maximum Length: 240

  Identifier of the project enterprise expense resource in an external application.
• ResourceId: integer (int64)
  Title: Resource ID

  Identifier of the project enterprise resource.
• ResourceName: string
  Title: Resource Name

  Maximum Length: 240

  Name of the project enterprise expense resource. Mandatory for POST operation if the Expenditure Type ID is not provided.

{
    "type":"object",
    "properties":{
        "ExpenditureTypeId":{
            "title":"Expenditure Type ID",
            "type":"integer",
            "description":"Name of the expenditure type of the project enterprise expense resource. Mandatory for POST operation if the resource is created from an expenditure type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expenditure type from which the project enterprise expense resource was created.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Additional details about the project enterprise expense resource.",
            "nullable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project enterprise expense resource. Mandatory for POST operation if the Expenditure Type ID is not provided.",
            "nullable":false
        },
        "ExternalId":{
            "title":"External ID",
            "maxLength":"240",
            "type":"string",
            "description":"Identifier of the project enterprise expense resource in an external application.",
            "nullable":true
        }
    }
}

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 : projectEnterpriseExpenseResources-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 2000

  Additional details about the project enterprise expense resource.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type ID

  Name of the expenditure type of the project enterprise expense resource. Mandatory for POST operation if the resource is created from an expenditure type.
• ExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  Name of the expenditure type from which the project enterprise expense resource was created.
• ExternalId: string
  Title: External ID

  Maximum Length: 240

  Identifier of the project enterprise expense resource in an external application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceId: integer (int64)
  Title: Resource ID

  Identifier of the project enterprise resource.
• ResourceName: string
  Title: Resource Name

  Maximum Length: 240

  Name of the project enterprise expense resource. Mandatory for POST operation if the Expenditure Type ID is not provided.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 30

  Default Value: Currency

  Unit of measurement of the expenditure of the project enterprise expense resource.

{
    "type":"object",
    "properties":{
        "ExpenditureTypeId":{
            "title":"Expenditure Type ID",
            "type":"integer",
            "description":"Name of the expenditure type of the project enterprise expense resource. Mandatory for POST operation if the resource is created from an expenditure type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expenditure type from which the project enterprise expense resource was created.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Additional details about the project enterprise expense resource.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measurement of the expenditure of the project enterprise expense resource.",
            "nullable":true,
            "readOnly":true,
            "default":"Currency",
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project enterprise expense resource. Mandatory for POST operation if the Expenditure Type ID is not provided.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalId":{
            "title":"External ID",
            "maxLength":"240",
            "type":"string",
            "description":"Identifier of the project enterprise expense resource in an external application.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top

Examples

The following example shows how to create an 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/projectEnterpriseExpenseResources

Request Body Example

The following shows an example of the request body in JSON format.

{
          
         "Description": "Exepenses for construction work",
         "ResourceName" : "Construction",
        "ExternalId"  : "1234"
    }

Response Body Example

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

{
  "ResourceId" : 300100125268008,
  "ExpenditureTypeId" : null,
  "ExpenditureTypeName" : null,
  "ResourceName" : "Construction",
  "UnitOfMeasure" : "Currency",
  "Description" : "Exepenses for construction work",
  "ExternalId" : "1234"

}

Back to Top