Get one procurement catalog upload process
get
/fscmRestApi/resources/11.13.18.05/procurementCatalogUploadProcesses/{procurementCatalogUploadProcessesUniqID}
Request
Path Parameters
-
procurementCatalogUploadProcessesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Procurement Catalog Upload Processes resource and used to uniquely identify an instance of Procurement Catalog Upload Processes. The client should not generate the hash key value. Instead, the client should query on the Procurement Catalog Upload Processes collection resource in order to navigate to a specific instance of Procurement Catalog Upload Processes 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
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context: string
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: string
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 : procurementCatalogUploadProcesses-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the procurement catalog upload process. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the procurement catalog upload process was created. -
DocumentUploadId: integer
(int64)
Read Only:
trueUnique identifier of the row with the document uploaded for catalog processing. -
FailureMessage: string
Title:
File ErrorRead Only:trueMaximum Length:240Error message that explains why the procurement catalog upload process had an error. -
FailureMessageCode: string
Read Only:
trueMaximum Length:30Code that identifies the reason the procurement catalog upload process didn't complete. -
FileContent: string
(byte)
Title:
File ContentContent of the file used by the upload process. -
FileName: string
Title:
File NameMaximum Length:1000Name of the file used for the procurement catalog upload process. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the upload process was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the upload process. -
LatestProcessFlag: boolean
Title:
Latest Process FlagRead Only:trueMaximum Length:1Indicates whether this process is the latest upload process. Contains one of the following values: true, false, or NULL. If true, then this process is the latest upload process. If false or NULL, then this process isn't the latest upload process. This attribute doesn't have a default value. -
LinesFailed: integer
(int32)
Title:
Lines with ErrorsRead Only:trueNumber of lines in error that couldn't be uploaded after the process was completed. -
LinesProcessed: integer
(int32)
Title:
Lines ProcessedRead Only:trueNumber of lines processed and uploaded after the process completed. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProcessCompletionDate: string
(date-time)
Title:
Completion DateRead Only:trueThe date when the upload process was completed. -
ProcessId: integer
(int64)
Title:
Process IDRead Only:trueUnique number that identifies the upload process. -
ProcessStartDate: string
(date-time)
Title:
Start DateRead Only:trueThe start date of the procurement upload process. -
ProcessStatus: string
Title:
Upload StatusRead Only:trueMaximum Length:80Status of the upload process. -
ProcessStatusCode: string
Read Only:
trueMaximum Length:20Default Value:PENDINGStatus code of the upload process. -
ProcessSubmissionDate: string
(date-time)
Title:
Uploaded DateRead Only:trueThe date when the upload process was submitted. -
ProcessType: string
Title:
Process TypeRead Only:trueMaximum Length:40Default Value:PUNCHOUT_ITEM_UPLOADFinds a procurement catalog upload process by the specified primary key. -
PunchoutCatalogId: integer
(int64)
Unique identifier of the punchout catalog for which the process was run.
-
PunchoutCatalogName: string
Title:
Catalog NameRead Only:trueMaximum Length:30Name of the punchout catalog for which the process was run. -
punchoutItemUploadErrors: array
Punchout Item Upload Errors
Title:
Punchout Item Upload ErrorsError information for punchout search item upload lines with processing errors. The information includes the attribute and its value that caused the error and identifies the attribute associated with the error. For example, a line can contain multiple error conditions. -
UploadedBy: string
Title:
Uploaded ByRead Only:trueMaximum Length:240Name of the user who ran the upload process.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Punchout Item Upload Errors
Type:
arrayTitle:
Punchout Item Upload ErrorsError information for punchout search item upload lines with processing errors. The information includes the attribute and its value that caused the error and identifies the attribute associated with the error. For example, a line can contain multiple error conditions.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : procurementCatalogUploadProcesses-punchoutItemUploadErrors-item-response
Type:
Show Source
object-
AttributeCode: string
Read Only:
trueMaximum Length:30Code that identifies the attribute that caused the error. -
AttributeName: string
Title:
AttributeRead Only:trueMaximum Length:80Name of the attribute that caused the error. -
AttributeValue: string
Title:
Attribute ValueRead Only:trueMaximum Length:100Value of the attribute that caused the error. -
CreatedBy: string
Title:
Created ByMaximum Length:64User who created the error record. -
CreationDate: string
(date-time)
Title:
Creation DateThe date when the error record was created. -
ErrorMessage: string
Title:
ErrorRead Only:trueMaximum Length:240Generated text that explains the upload issue for the punchout item on the specified line and attribute combination. -
ErrorMessageCode: string
Read Only:
trueMaximum Length:30Code that identifies the error message. -
FileLine: integer
(int32)
Title:
File LineRead Only:trueLine number in the file where the error occurred. -
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Text that describes the punchout search item. -
ItemErrorId: integer
(int64)
Read Only:
trueUnique identifier of the error. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the error record. -
LastUpdatedDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the error record was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProcessId: integer
(int64)
Read Only:
trueUnique identifier of the upload process. -
SupplierItem: string
Title:
Supplier ItemRead Only:trueMaximum Length:300Supplier item number associated with the item. -
SupplierItemAuxillaryId: string
Title:
Supplier Item Auxiliary IdentifierRead Only:trueMaximum Length:255Auxiliary identifier of the supplier item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- punchoutItemUploadErrors
-
Parameters:
- procurementCatalogUploadProcessesUniqID:
$request.path.procurementCatalogUploadProcessesUniqID
Error information for punchout search item upload lines with processing errors. The information includes the attribute and its value that caused the error and identifies the attribute associated with the error. For example, a line can contain multiple error conditions. - procurementCatalogUploadProcessesUniqID: