Get one error
get
/fscmRestApi/resources/11.13.18.05/purchasingDocumentImportErrors/{purchasingDocumentImportErrorsUniqID}
Request
Path Parameters
-
purchasingDocumentImportErrorsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- InterfaceTransactionId and InterfaceType ---for the Purchasing Document Import Errors resource and used to uniquely identify an instance of Purchasing Document Import Errors. The client should not generate the hash key value. Instead, the client should query on the Purchasing Document Import Errors collection resource with a filter on the primary key values in order to navigate to a specific instance of Purchasing Document Import Errors.
For example: purchasingDocumentImportErrors?q=InterfaceTransactionId=<value1>;InterfaceType=<value2>
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 TopResponse
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.
Root Schema : purchasingDocumentImportErrors-item-response
Type:
Show Source
object
-
BatchId: integer
(int64)
Read Only:
true
Unique identifier of batch being processed at the time of error. -
ColumnName: string
Read Only:
true
Maximum Length:30
Value that uniquely identifies the error column name. -
ColumnValue: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the error column value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
ErrorMessage: string
Read Only:
true
Maximum Length:2000
Error detail text generated by a row that failed to migrate. -
ErrorMessageName: string
Read Only:
true
Maximum Length:30
Error identifier generated by a row that failed to migrate. -
InterfaceAssignmentId: integer
(int64)
Read Only:
true
Unique identifier of the organization assignment being processed at the time of error. -
InterfaceAttrValuesId: integer
(int64)
Read Only:
true
Unique identifier of the attribute values interface line being processed at the time of error. -
InterfaceAttrValuesTlpId: integer
(int64)
Read Only:
true
Unique identifier of the partial translations for an interface line being processed at the time of error. -
InterfaceDistributionId: integer
(int64)
Read Only:
true
Unique identifier of the distribution being processed at the time of error. -
InterfaceHeaderId: integer
(int64)
Read Only:
true
Unique identifier of the header being processed at the time of error. -
InterfaceLineId: integer
(int64)
Read Only:
true
Unique identifier of the line being processed at the time of error. -
InterfaceLineLocationId: integer
(int64)
Read Only:
true
Unique identifier of the line location being processed at the time of error. -
InterfaceTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the error transaction. -
InterfaceType: string
Read Only:
true
Maximum Length:25
Value that uniquely identifies the error message source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessingDate: string
(date)
Read Only:
true
Date that identifies the error transaction date. -
RequestId: integer
(int64)
Read Only:
true
Value that indicates the request ID of the job that created or last updated the row. -
TableName: string
Read Only:
true
Maximum Length:30
Value that indicates the error related table.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get one purchasing document import error.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchasingDocumentImportErrors/InterfaceTransactionId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/49227"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items" : [ { "InterfaceTransactionId" : 49227, "InterfaceType" : "PO_DOCS_OPEN_INTERFACE", "BatchId" : 114455, "RequestId" : 158546, "ColumnName" : "AGENT_NAME", "ColumnValue" : "Clare Furey", "ErrorMessage" : "The buyer isn't valid. Verify that the buyer is an active user, is an active procurement agent, matches the name format used in the Oracle Human Capital Management Cloud, and is allowed to manage purchasing documents for the procurement business unit.", "ErrorMessageName" : "PO_PDOI_BUYER_VALID", "TableName" : "PO_HEADERS_INTERFACE", "InterfaceAssignmentId" : null, "InterfaceAttrValuesId" : null, "InterfaceAttrValuesTlpId" : null, "InterfaceDistributionId" : null, "InterfaceHeaderId" : 300100590192348, "InterfaceLineId" : null, "InterfaceLineLocationId" : null, "ProcessingDate" : "2024-01-17", "CreatedBy" : "CVBUYER01", "CreationDate" : "2024-01-17T06:44:23+00:00", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/purchasingDocumentImportErrors/00020000000EACED00057708000000000000C04B00000016504F5F444F43535F4F50454E5F494E54455246414345", "name" : "purchasingDocumentImportErrors", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/purchasingDocumentImportErrors/00020000000EACED00057708000000000000C04B00000016504F5F444F43535F4F50454E5F494E54455246414345", "name" : "purchasingDocumentImportErrors", "kind" : "item" } ] } ], "count" : 1, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/purchasingDocumentImportErrors", "name" : "purchasingDocumentImportErrors", "kind" : "collection" } ] }