Get all errors for an unprocessed project cost

get

/fscmRestApi/resources/11.13.18.05/unprocessedProjectCosts/{unprocessedProjectCostsUniqID}/child/Errors

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Unprocessed Project Costs resource and used to uniquely identify an instance of Unprocessed Project Costs. The client should not generate the hash key value. Instead, the client should query on the Unprocessed Project Costs collection resource in order to navigate to a specific instance of Unprocessed Project Costs to get the hash key.
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds all unprocessed project cost errors with the specified ID.
      Finder Variables:
      • TransactionErrorId; integer; Identifier of the error due to which the unprocessed cost was rejected.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ErrorStage; string; The stage during processing in which an unprocessed cost is rejected from being processed. Processing can resume from the error stage. A list of valid values is defined in the lookup type PJC_TI_STAGE. There is no default value while creating an unprocessed cost.
    • ErrorStageCode; string; Identifies the stage during processing in which an unprocessed cost is rejected from being processed. Processing can resume from the error stage. A list of valid values is defined in the lookup type PJC_TI_STAGE. There is no default value while creating an unprocessed cost.
    • MessageAdministratorAction; string; The action that the administrator must perform to resolve the rejection and make the unprocessed cost eligible for processing.
    • MessageAdministratorDetails; string; Additional information provided to administrators about the rejection of the transaction.
    • MessageCause; string; Reason due to which the unprocessed project cost was rejected.
    • MessageName; string; Name that identifies the message uniquely.
    • MessageText; string; Text of the message that indicates the cause and resolution of the rejection of the unprocessed project cost.
    • MessageUserAction; string; The action that you must perform to resolve the issue and make the unprocessed project cost eligible for processing.
    • MessageUserDetails; string; Additional information about the cause and resolution of the rejection of the unprocessed project cost.
    • ProcessId; integer; Identifier of the scheduled process during which the unprocessed cost was rejected.
    • RejectionType; string; Indicates the type of the rejection, for example, Error or Warning.
    • SourceTransactionId; integer; Identifier of the unprocessed cost.
    • TransactionErrorId; integer; Identifier of the error due to which the unprocessed cost was rejected.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : unprocessedProjectCosts-Errors
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : unprocessedProjectCosts-Errors-item-response
Type: object
Show Source
  • Title: Error Stage
    Read Only: true
    Maximum Length: 80
    The stage during processing in which an unprocessed cost is rejected from being processed. Processing can resume from the error stage. A list of valid values is defined in the lookup type PJC_TI_STAGE. There is no default value while creating an unprocessed cost.
  • Title: Error Stage Code
    Maximum Length: 20
    Identifies the stage during processing in which an unprocessed cost is rejected from being processed. Processing can resume from the error stage. A list of valid values is defined in the lookup type PJC_TI_STAGE. There is no default value while creating an unprocessed cost.
  • Links
  • Title: Root Cause Message Administrator Action
    Read Only: true
    Maximum Length: 4000
    The action that the administrator must perform to resolve the rejection and make the unprocessed cost eligible for processing.
  • Title: Root Cause Message Administrator Details
    Read Only: true
    Maximum Length: 4000
    Additional information provided to administrators about the rejection of the transaction.
  • Title: Message Cause
    Read Only: true
    Maximum Length: 4000
    Reason due to which the unprocessed project cost was rejected.
  • Title: Message Name
    Maximum Length: 30
    Name that identifies the message uniquely.
  • Title: Message Text
    Read Only: true
    Maximum Length: 240
    Text of the message that indicates the cause and resolution of the rejection of the unprocessed project cost.
  • Title: Message Action
    Read Only: true
    Maximum Length: 4000
    The action that you must perform to resolve the issue and make the unprocessed project cost eligible for processing.
  • Title: Message Details
    Read Only: true
    Maximum Length: 4000
    Additional information about the cause and resolution of the rejection of the unprocessed project cost.
  • Title: Process ID
    Read Only: true
    Identifier of the scheduled process during which the unprocessed cost was rejected.
  • Title: Rejection Type
    Read Only: true
    Maximum Length: 80
    Indicates the type of the rejection, for example, Error or Warning.
  • Title: Transaction Number
    Read Only: true
    Identifier of the unprocessed cost.
  • Title: Error ID
    Read Only: true
    Identifier of the error due to which the unprocessed cost was rejected.
Back to Top

Examples

The following example shows how to get all errors for an unprocessed project cost 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/unprocessedProjectCosts/300100059831542/child/Errors

Response Body Example

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

{
"items": [
  {
"TransactionErrorId": 100100037489406,
"SourceTransactionId": 300100059831542,
"ErrorStage": "Derivations",
"ErrorStageCode": "DERIVATIONS",
"RejectionType": "Warning",
"MessageName": "PJC_DENOM_CURRENCY_WIPED_OFF",
"MessageText": "You do not need to provide the transaction currency because it is a transaction that is not costed.",
"MessageUserDetails": "No error is generated if you provide a value, but the value is ignored because the application derives it internally.",
"MessageCause": null,
"MessageUserAction": null,
"MessageAdministratorAction": null,
"MessageAdministratorDetails": null,
"ProcessId": 7173
}	
Back to Top