Class WorkRecords

constructor

• new WorkRecords(api: Api): WorkRecords

  Parameters

  • api: Api

  Returns WorkRecords

api

archive

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

  Parameters

  • type: string
  • hash: string
  • recordId: string

  Returns Promise<ApiResponse<unknown, unknown>>

create

• create(
      type: string,
      hash: string,
      organization: string,
      data: WorkRecordData,
  ): 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: string,
      hash: string,
      organization: string,
      data: WorkRecordData,
  ): Promise<ApiResponse<CountingWorkRecord, void>>

  Parameters

  • type: string
  • hash: string
  • organization: string
  • data: WorkRecordData

  Returns Promise<ApiResponse<CountingWorkRecord, void>>

get

• get(
      type: string,
      hash: string,
      recordId: string,
  ): 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: string,
  ): Promise<ApiResponse<WorkRecordConfiguration, void>>

  Parameters

  • hash: string

  Returns Promise<ApiResponse<WorkRecordConfiguration, void>>

listConfigurations

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

  Parameters

  • organization: string
  • type: string

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

listCountingWorkRecords

• listCountingWorkRecords(
      element: string,
      options?: { limit: number; offset: number; sort: string },
  ): Promise<ApiResponse<CountingWorkRecord[], void>>

  Parameters

  • element: string
  • Optionaloptions: { limit: number; offset: number; sort: string }

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