GET the incoming pcf requests of my company. it is recommended to make use of the "status" query parameter as follows /tasks/inboundPcfRequests?status=NEW,PCF_SHARED,COMPLETED.
GET {{baseUrl}}/tasks/inboundPcfRequests?searchText=<string>&productName=<string>&taskId=<string>&companyName=<string>&pcfId=<string>&productFamily=<string>&status=<string>&from=<dateTime>&to=<dateTime>&sort=<string>&page=0&size=10
GET the incoming pcf requests received for company in SiGREEN.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
searchText | string | Free text search for incoming pcf requests that will look in the attribute of Task ID, Product name, Company Name(Requester company name) of a company in SiGREEN | |
productName | string | Product name of the company in SiGREEN | |
taskId | string | Task Id for identifying the incoming pcf request of the company in SiGREEN | |
companyName | string | Name of the customer company | |
pcfId | string | Id for identifying the pcf data shared in my company | |
productFamily | string | Product family name of the product my company | |
status | string | Inbound pcf request task status. Multiple fields could be used separated by commas (e.g. "NEW","PCF_SHARED").. Available values : NEW, PCF_SHARED, 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 updated in SiGREEN.DateTime (ISO 8601; UTC Timezone) | |
sort | string | The order of returned elements.sort supporting fields(taskId,productName,companyName) for inbound 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":[{"companyName":"companyName","id":"UUID","lastUpdatedTimeStamp":"2022-11-20T08:30Z","pcfData":{"pcfId":"pcfId"},"pcfRequestedData":{"location":"location","declaredUnit":"kg","standards":"TFS V2","message":"PCF request message","identifiers":[{"type":"ean","value":"4667"}]},"productFamily":"productFamily","productName":"productName","requestTimeStamp":"2022-11-20T08:30Z","status":"NEW","taskId":"T001","taskType":"PCF_REQUEST","type":"Received"},{"companyName":"companyName","id":"UUID","lastUpdatedTimeStamp":"2022-11-20T08:30Z","pcfData":{"pcfId":"pcfId"},"pcfRequestedData":{"location":"location","declaredUnit":"kg","standards":"TFS V2","message":"PCF request message","identifiers":[{"type":"ean","value":"4667"}]},"productFamily":"productFamily","productName":"productName","requestTimeStamp":"2022-11-20T08:30Z","status":"NEW","taskId":"T001","taskType":"PCF_REQUEST","type":"Received"}],"hasNext":true,"hasPrev":false,"page":0,"pageNumber":1,"size":10,"totalPages":120}