Class WorkRecords

constructor

• new WorkRecords(api): WorkRecords

• Parameters

  • api: Api

  Returns WorkRecords

api

archive

• archive(type, hash, recordId): Promise<ApiResponse<unknown, unknown>>

• Parameters

  • type: string

  • hash: string

  • recordId: string

  Returns Promise<ApiResponse<unknown, unknown>>

create

• create(type, hash, organization, data): Promise<ApiResponse<{
      hash: string;
      links: RestApiLink[];
  }, {
      hash: string;
      links: RestApiLink[];
  }>>

• Parameters

  • type: string

  • hash: string

  • organization: string

  • data: WorkRecordData

  Returns Promise<ApiResponse<{
      hash: string;
      links: RestApiLink[];
  }, {
      hash: string;
      links: RestApiLink[];
  }>>

createCountingWorkRecord

• createCountingWorkRecord(type, hash, organization, data): Promise<ApiResponse<CountingWorkRecord, void>>

• Parameters

  • type: string

  • hash: string

  • organization: string

  • data: WorkRecordData

  Returns Promise<ApiResponse<CountingWorkRecord, void>>

get

• get(type, hash, recordId): Promise<ApiResponse<{
      links?: RestApiLink[];
      work_record: IWorkRecord;
  }, {
      links?: RestApiLink[];
      work_record: IWorkRecord;
  }>>

• Parameters

  • type: string

  • hash: string

  • recordId: string

  Returns Promise<ApiResponse<{
      links?: RestApiLink[];
      work_record: IWorkRecord;
  }, {
      links?: RestApiLink[];
      work_record: IWorkRecord;
  }>>

getConfiguration

• getConfiguration(hash): Promise<ApiResponse<WorkRecordConfiguration, void>>

• Parameters

  • hash: string

  Returns Promise<ApiResponse<WorkRecordConfiguration, void>>

listConfigurations

• listConfigurations(organization, type): Promise<ApiResponse<CountingWorkRecordIdentity[], void>>

• Parameters

  • organization: string

  • type: string

  Returns Promise<ApiResponse<CountingWorkRecordIdentity[], void>>

listCountingWorkRecords

• listCountingWorkRecords(element, options?): Promise<ApiResponse<CountingWorkRecord[], void>>

• Parameters

  • element: string

  • Optional options: {
        limit: number;
        offset: number;
        sort: string;
    }

    • limit: number

    • offset: number

    • sort: string

  Returns Promise<ApiResponse<CountingWorkRecord[], void>>