Options for a given request.

The client constructor and most operations take an Options object as the final parameter. If this object is passed into the constructor, it is set as the default and used whenever no Options object is give. If no options are given when creating a client, an empty object is used by default.

Index

Properties

Properties

Optional asUserId

asUserId: string

Cordra ID of user to perform operation as

Optional attributes

attributes: object

Request attributes

Type declaration

  • [x: string]: unknown

Optional callHeaders

callHeaders: object

Information about headers to include on the request for callMethod and variants

Type declaration

  • Optional filename?: string

    The filename is sent over HTTP using the Content-Disposition header

  • Optional mediaType?: string

    The media type is sent over HTTP as the Content-Type header

Optional filter

filter: string[]

Filter for getting object with filtered features

Optional full

full: boolean

Optional includeResponseContext

includeResponseContext: boolean

Whether to request the inclusion of a responseContext

Optional isDryRun

isDryRun: boolean

Whether to do a dry run of the operation

Optional password

password: string

User password

Optional privateKey

privateKey: JsonWebKey

User private key

Optional requestContext

requestContext: object

Type declaration

  • [x: string]: unknown

Optional suffix

suffix: string

Suffix to add to generated ID on object creation

Optional token

token: null | string

Bearer token to use for authentication

Optional userId

userId: string

Cordra ID of the user

Optional username

username: string

Username of the user

Generated using TypeDoc