This class provides RESTful services to display summary and detail for a file upload job. It uses the FileUploadJob noun.
com.ibm.commerce.rest.fileupload.handler.FileUploadJobHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/file_upload_job?q={q} | Finds file upload jobs by a query. See each query for details on input and output. |
GET | /store/{storeId}/file_upload_job?q=byNumberOfDaysAndUploadType | Finds the file upload jobs in recent specified days by upload type. |
GET | /store/{storeId}/file_upload_job?q=byUploadType | Gets file upload jobs by file upload job type. |
GET | /store/{storeId}/file_upload_job/{fileUploadJobId} | Finds a file upload job by its ID. |
Finds file upload jobs by a query. See each query for details on input and output.
findByQuery
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Finds the file upload jobs in recent specified days by upload type.
byNumberOfDaysAndUploadType
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
numberOfDays | Returns the file upload jobs loaded later than the specified number days from current date | query | string | true | false |
uploadType | Returns the file upload jobs of the specified upload type, for example, RequisitionListUpload | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets file upload jobs by file upload job type.
byUploadType
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
uploadType | Returns the file upload jobs of the specified upload type, for example, RequisitionListUpload | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Finds a file upload job by its ID.
findByFileUploadJobId
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
fileUploadJobId | The file upload job ID. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Name | Data Type | Required |
---|---|---|
filePath | string | false |
fileName | string | true |
fileSize | string | false |
fileEncoding | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
resultList | file_upload_job-IBM_Store_Summary_item array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | file_upload_job-IBM_Store_Summary_item.userDataField array | false |
uploadType | string | false |
fileUploadJobId | string | false |
processFile | file_upload_job-IBM_Store_Summary_item.processFile array | false |
storeId | string | false |
uploadFile | string | false |
Name | Data Type | Required |
---|---|---|
status | string | false |
endTime | string | false |
startTime | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
properties | file_upload_job-FileProperty array | false |
userName | string | false |
fileInfo | string | false |
uploadTime | string | false |