/api/colors/{refNo} (Update color's docStatus by refNo)

update color's docStatus by refNo.

PATCH/api/colors/{refNo}

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/colors/{refNo} (Update color's docStatus by refNo) action (under ColorController).
Fill in the fields below, then reference the result from later steps as {{apiColorsRefnoUpdateColorSDocstatusByRefno.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

versioninteger (int32)

docStatusstringrequired

One ofACTIVEINACTIVECANCELED

Response

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

idstring

hexCodestring

refNostring

codestring

colorNamestring

serviceNostring

serviceNameobject

codestringrequired

namestring

versioninteger (int32)

customerReferenceNostring

json

{
  "id": "string",
  "hexCode": "string",
  "refNo": "string",
  "code": "string",
  "colorName": "string",
  "serviceNo": "string",
  "serviceName": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "customerReferenceNo": "string"
}

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

Was this page helpful?