Class BasicApi

Hierarchy

  • BasicApi

Constructors

constructor

Properties

api

Methods

archive create getById getPage update

Constructors

constructor

Properties

Private api

api: ObservableBasicApi

Methods

archive

create

getById

  • Read an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param. Read

    Parameters

    • companyId: string
    • Optional properties: string[]

      A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

    • Optional propertiesWithHistory: string[]

      A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.

    • Optional associations: string[]

      A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

    • Optional archived: boolean

      Whether to return only results that have been archived.

    • Optional idProperty: string

      The name of a property whose values are unique for this object type

    • Optional _options: Configuration

    Returns Promise<SimplePublicObjectWithAssociations>

getPage

  • Read a page of companies. Control what is returned via the properties query param. List

    Parameters

    • Optional limit: number

      The maximum number of results to display per page.

    • Optional after: string

      The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

    • Optional properties: string[]

      A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

    • Optional propertiesWithHistory: string[]

      A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.

    • Optional associations: string[]

      A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

    • Optional archived: boolean

      Whether to return only results that have been archived.

    • Optional _options: Configuration

    Returns Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>

update

  • Perform a partial update of an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. Update

    Parameters

    • companyId: string
    • simplePublicObjectInput: SimplePublicObjectInput
    • Optional idProperty: string

      The name of a property whose values are unique for this object type

    • Optional _options: Configuration

    Returns Promise<SimplePublicObject>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc