Jump to

• Request
• Response
• Examples

Get an error for an unprocessed project cost

get

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

Request

Path Parameters

• TransactionErrorId(required): integer(int64)
  Identifier of the error due to which the unprocessed cost was rejected.
• unprocessedProjectCostsUniqID(required): string
  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

• 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 : unprocessedProjectCosts-Errors-item-response

Type: object

Show Source

• ErrorStage: string
  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.
• ErrorStageCode: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageAdministratorAction: string
  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.
• MessageAdministratorDetails: string
  Title: Root Cause Message Administrator Details

  Read Only: true

  Maximum Length: 4000

  Additional information provided to administrators about the rejection of the transaction.
• MessageCause: string
  Title: Message Cause

  Read Only: true

  Maximum Length: 4000

  Reason due to which the unprocessed project cost was rejected.
• MessageName: string
  Title: Message Name

  Maximum Length: 30

  Name that identifies the message uniquely.
• MessageText: string
  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.
• MessageUserAction: string
  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.
• MessageUserDetails: string
  Title: Message Details

  Read Only: true

  Maximum Length: 4000

  Additional information about the cause and resolution of the rejection of the unprocessed project cost.
• ProcessId: integer (int64)
  Title: Process ID

  Read Only: true

  Identifier of the scheduled process during which the unprocessed cost was rejected.
• RejectionType: string
  Title: Rejection Type

  Read Only: true

  Maximum Length: 80

  Indicates the type of the rejection, for example, Error or Warning.
• SourceTransactionId: integer (int64)
  Title: Transaction Number

  Read Only: true

  Identifier of the unprocessed cost.
• TransactionErrorId: integer (int64)
  Title: Error ID

  Read Only: true

  Identifier of the error due to which the unprocessed cost was rejected.

{
    "type":"object",
    "properties":{
        "ErrorStageCode":{
            "title":"Error Stage Code",
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "RejectionType":{
            "title":"Rejection Type",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the type of the rejection, for example, Error or Warning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageUserDetails":{
            "title":"Message Details",
            "maxLength":"4000",
            "type":"string",
            "description":"Additional information about the cause and resolution of the rejection of the unprocessed project cost.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageUserAction":{
            "title":"Message Action",
            "maxLength":"4000",
            "type":"string",
            "description":"The action that you must perform to resolve the issue and make the unprocessed project cost eligible for processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageText":{
            "title":"Message Text",
            "maxLength":"240",
            "type":"string",
            "description":"Text of the message that indicates the cause and resolution of the rejection of the unprocessed project cost.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionErrorId":{
            "title":"Error ID",
            "type":"integer",
            "description":"Identifier of the error due to which the unprocessed cost was rejected.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name that identifies the message uniquely.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageCause":{
            "title":"Message Cause",
            "maxLength":"4000",
            "type":"string",
            "description":"Reason due to which the unprocessed project cost was rejected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorStage":{
            "title":"Error Stage",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "title":"Transaction Number",
            "type":"integer",
            "description":"Identifier of the unprocessed cost.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"Identifier of the scheduled process during which the unprocessed cost was rejected.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageAdministratorDetails":{
            "title":"Root Cause Message Administrator Details",
            "maxLength":"4000",
            "type":"string",
            "description":"Additional information provided to administrators about the rejection of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageAdministratorAction":{
            "title":"Root Cause Message Administrator Action",
            "maxLength":"4000",
            "type":"string",
            "description":"The action that the administrator must perform to resolve the rejection and make the unprocessed cost eligible for processing.",
            "nullable":true,
            "readOnly":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 get an error 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/100100037489406

Response Body Example

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

{
"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