GET the outbound pcf requests of my company. it is recommended to make use of the "status" query parameter as follows /tasks/outboundPcfRequests?status=NEW,PCF_RECEIVED,COMPLETED.
GET /tasks/tasks/outboundPcfRequests?searchText=<string>&componentName=<string>&taskId=<string>&supplierId=<string>&supplierName=<string>&pcfId=<string>&materialCategory=<string>&status=<string>&from=<dateTime>&to=<dateTime>&sort=<integer>&page=0&size=10
GET the outbound requests sent for company in SiGREEN.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
searchText | string | Free text search for outbound pcf requests that will look in the attribute of Task ID,component name,supplierName of a company in SiGREEN. | |
componentName | string | Component name of the company in SiGREEN | |
taskId | string | Task Id for identifying the outbound pcf request of the company in SiGREEN | |
supplierId | string | SupplierId of the supplier company | |
supplierName | string | Name of the supplier company | |
pcfId | string | Id for identifying the pcf data received in my company | |
materialCategory | string | MaterialCategory of the component my company | |
status | string | Outbound pcf request status. Multiple fields could be used separated by commas (e.g. "PCF_RECEIVED","UNDER_REVIEW"). Available values : NEW, PCF_RECEIVED, UNDER_REVIEW, WITHDRAWN, COMPLETED, REJECTED_PCF, DENIED, CANCELLED | |
from | string | The start date of the date range when the task was created or updated in SiGREEN.DateTime (ISO 8601; UTC Timezone) | |
to | string | The end date of the date range when the task was created or update in SiGREEN.DateTime (ISO 8601; UTC Timezone) | |
sort | string | The order of returned elements.sort supporting fields(taskId,componentName,supplierName,supplierId,requestTimeStamp) in outbound pcf requests.Descending order could be requested by appending '-' ,ascending '+' at the prefix of parameter.(e.g. '+taskId)' | |
page | number | This is an integer representing the page-number to fetch. 0 would be the first page.(e.g 'page=0') | |
size | number | This is used for the requested maximum page size.(e.g. 'size=10') |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"UUID","taskId":"T001","pcfRequestedData":{"location":"location","declaredUnit":"kg","standards":"TFS V2","message":"PCF request message","identifiers":[{"type":"ean","value":"4667"}]},"pcfData":{"pcfId":"pcfId","standards":["TFS V2","PACT V2.0.0"]},"componentName":"componentName","supplierName":"supplier Name","type":"Received","taskType":"PCF_REQUEST","status":"NEW","requestTimeStamp":"2022-11-20T08:30Z","lastUpdatedTimeStamp":"2022-11-20T08:30Z","materialCategory":"materialCategory","supplierId":"supplier id"},{"id":"UUID","taskId":"T001","pcfRequestedData":{"location":"location","declaredUnit":"kg","standards":"TFS V2","message":"PCF request message","identifiers":[{"type":"ean","value":"4667"}]},"pcfData":{"pcfId":"pcfId","standards":["TFS V2","PACT V2.0.0"]},"componentName":"componentName","supplierName":"supplier Name","type":"Received","taskType":"PCF_REQUEST","status":"NEW","requestTimeStamp":"2022-11-20T08:30Z","lastUpdatedTimeStamp":"2022-11-20T08:30Z","materialCategory":"materialCategory","supplierId":"supplier id"}],"hasNext":true,"hasPrev":false,"page":0,"pageNumber":1,"size":10,"totalPages":120}