postInstance MethodProtected

Used by clients to post strongly typed instances through standard WSG REST API

postInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: { T }, relativeUrlPath: string, instance: T extends WsgInstance, requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance>

Parameter Type Description
requestContext AuthorizedClientRequestContext The client request context
typedConstructor { T } Used by clients to post a strongly typed instance through the REST API that's expected to return a standard response.
relativeUrlPath string Relative path to the REST resource.
instance T extends WsgInstance Strongly typed instance to be posted.
requestOptions WsgRequestOptions WSG options for the request.

Returns - Promise<T extends WsgInstance>

The posted instance that's returned back from the server.

Defined in

Last Updated: 13 June, 2024