@salesforce/b2c-tooling-sdk / scapi / ScapiConfirmation
Interface: ScapiConfirmation
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:36
Exact, resolved request awaiting approval. Credentials are never included.
Properties
api
api:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:47
API ID, <family>/<name>/<version>, e.g. product/products/v1.
apiFamily
apiFamily:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:49
API family, e.g. product.
body?
optionalbody:unknown
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:43
callId?
optionalcallId:number
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:60
The program's own number for the call (see ScapiCall.id), when the helper is called from runScapiCode. Stable across replays of the same program, so hosts can key approvals by it.
method
method:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:39
operationId
operationId:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:38
Schema operation ID, e.g. updateProduct.
pathParams
pathParams:
Record<string,string>
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:53
Values of the template's path parameters, decoded.
pathTemplate
pathTemplate:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:51
Schema path template including the API prefix, e.g. /product/products/v1/organizations/{organizationId}/products/{id}.
query
query:
Record<string,unknown>
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:42
reason
reason:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:45
Why safety asked for confirmation.
requestIndex
requestIndex:
number
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:55
Zero-based position of this request among the requests made with this helper.
url
url:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:41
Full request URL without the query string.