/api/sample_requests/{refNo} (Update SampleRequest's docStatus by refNo)

update SampleRequest's docStatus by refNo.

PATCH/api/sample_requests/{refNo}

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/sample_requests/{refNo} (Update SampleRequest's docStatus by refNo) action (under SampleRequestController).
Fill in the fields below, then reference the result from later steps as {{apiSampleRequestsRefnoUpdateSamplerequestSDocstatusByRefno.response.data}}.

Request

Path parameters

refNostringrequired

Query parameters

statusstringrequired

One ofCONCEPTCOSTINGADOPTEDFINALIZEDNEWQUOTEDCONFIRMEDTOBUYREJECTEDTOBUYREVISEPROPOSEDOVERRIDDENSHORTLISTEDREMOVE_FROM_SHORTLISTSOURCINGPHASE_1_TRACKING_COMPLETEDMARK_AS_DEFAULTDRAFTCONFIRMEDOFFICIALSUBMITTEDREQUESTEDRELEASED_TO_VENDORVENDOR_CONFIRMEDBUYER_CONFIRMEDVENDOR_CHANGE_PROPOSEDVENDOR_REJECTEDBUYER_REJECTEDVENDOR_CONFIRMATION_SENTVENDOR_REJECTION_SENTCOMPLETEDSCHEDULEDPO_CHANGE_PROPOSEDCHANGE_ACCEPTEDCHANGE_REJECTEDPO_ACCEPTEDPO_REJECTEDOUT_OF_SIGNATURESIGNEDREVISION_REQUESTCLOSED

approvalTemplateIdstring

docStatusstringrequired

One ofACTIVEINACTIVECANCELED

versioninteger (int32)

Response

Returns 200 with an object. Read it in later steps with {{apiSampleRequestsRefnoUpdateSamplerequestSDocstatusByRefno.response.data.<field>}}.

idstring

refNostring

domainIdstring

versioninteger (int32)

sampleRequestNostring

json

{
  "id": "string",
  "refNo": "string",
  "domainId": "string",
  "version": 0,
  "sampleRequestNo": "string"
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.

Was this page helpful?