Jump to

• Request
• Response
• Examples

Get an expense resource assignment for a task

get

/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskExpenseResourceAssignments/{TaskExpenseResourceAssignmentId}

Request

Path Parameters

• ProjectId(required): integer(int64)
  Unique identifier of the project.
• TaskExpenseResourceAssignmentId(required): integer(int64)
  Unique identifier of the expense resource assignment to the project task. Value is auto-generated when using POST and mandatory when using PATCH.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : projectPlans-TaskExpenseResourceAssignments-item-response

Type: object

Show Source

• ActualAmount: number
  Title: Expense Resource Actual Amount

  Default Value: 0

  The actual expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• CurrentAmount: number
  Title: Expense Resource Current Amount

  The current expense cost amount of a specific expense resource assigned to the task. It is auto-calculated as the sum of Expense Resource Actual Amount plus Expense Resource Remaining Amount.
• ExpenseResourceId: integer (int64)
  Title: Expense Resource ID

  Identifier of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.
• IntegrationSource: string
  Title: Integration Source

  Indicates the task was created in a third-party application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlannedAmount: number
  Title: Expense Resource Planned Amount

  Default Value: 0

  The planned expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• RemainingAmount: number
  Title: Expense Resource Remaining Amount

  Default Value: 0

  The remaining expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• ResourceName: string
  Title: Expense Resource Name

  Maximum Length: 240

  Name of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.
• TaskExpenseResourceAssignmentId: integer (int64)
  Title: Expense Resource Assignment ID

  Read Only: true

  Unique identifier of the expense resource assignment to the project task. Value is auto-generated when using POST and mandatory when using PATCH.
• TaskId: integer (int64)
  Title: Task ID

  Identifier of the task to which the expense resource is assigned. Value is mandatory when using POST and must refer to a task that already exists in the project.

{
    "type":"object",
    "properties":{
        "TaskExpenseResourceAssignmentId":{
            "title":"Expense Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the expense resource assignment to the project task. Value is auto-generated when using POST and mandatory when using PATCH.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the expense resource is assigned. Value is mandatory when using POST and must refer to a task that already exists in the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Expense Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenseResourceId":{
            "title":"Expense Resource ID",
            "type":"integer",
            "description":"Identifier of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ResourceName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActualAmount":{
            "title":"Expense Resource Actual Amount",
            "type":"number",
            "description":"The actual expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "PlannedAmount":{
            "title":"Expense Resource Planned Amount",
            "type":"number",
            "description":"The planned expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "CurrentAmount":{
            "title":"Expense Resource Current Amount",
            "type":"number",
            "description":"The current expense cost amount of a specific expense resource assigned to the task. It is auto-calculated as the sum of Expense Resource Actual Amount plus Expense Resource Remaining Amount.",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "title":"Integration Source",
            "type":"string",
            "description":"Indicates the task was created in a third-party application.",
            "nullable":true,
            "x-queryable":false
        },
        "RemainingAmount":{
            "title":"Expense Resource Remaining Amount",
            "type":"number",
            "description":"The remaining expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "nullable":true,
            "default":"0",
            "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 get a expense resource assignment by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100124723999/child/TaskExpenseResourceAssignments/300100124762029

Example of Response Body

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

{
    "ActualAmount": 100,
    "CurrentAmount": 100,
    "TaskExpenseResourceAssignmentId": 300100124762029,
    "ExpenseResourceId": 1001,
    "PlannedAmount": 51,
    "RemainingAmount": 0,
    "ResourceName": "Air",
    "TaskId": 300100124764034
}

Back to Top