Class Requests

Hierarchy

  • Requests

Constructors

Methods

Constructors

Methods

  • Get the status of a request.

    Use this method to query the status of a request. If the request is a multiple app gen request, the returned RequestStatus object will contain an embedded array of RequestStatus objects, one for each sub-request of the multiple app gen request.

    Parameters

    • arg: {
          id: string;
      }
      • id: string

    Returns Promise<Request>

  • Returns a list of ODAG request objects matching the combination of search criteria provided. Only a single ID parameter may be supplied in a single request but any combination of the other parameters may be included. The OptEngineGroupNamePattern and OptEngineGroupId further restricts the set of returned requests to those that are (or were) assigned to specific engine groups. These two engine group parameters are only supported in the premium version of the ODAG service and an error will be returned on any attempt to supply values for both parameters in the same method call.

    Parameters

    • Optional arg: {
          createdBefore?: string;
          optLinkId?: string;
          optSelectAppId?: string;
          state?: string;
          user?: string;
      }
      • Optional createdBefore?: string

        A time range in which an object was created prior to the specified timestamp.

      • Optional optLinkId?: string

        The ID of a link to match objects to be returned.

      • Optional optSelectAppId?: string

        An optional parameter for specifying the ID of a selection app.

      • Optional state?: string

        Any combination of the following request state flags: q = queued, v = validating, i = invalid,c = canceled, h = hold/pending, l = loading, f = done but failed, s = done successfully, d = done (success or failed)

      • Optional user?: string

        The name of the user who submitted the request.

    Returns Promise<Request[]>