OpenAPI - Transfer documents

Knowledge base
,
1

The Transfer Documents API collections help you effectively manage documents associated with jobs or equipment within Onix system.

Access the APIs

  • Open Swagger API documentation.
  • For “Transfers Documents”: Locate the Jobs and Equipment for the available API endpoints
  • To check the necessary information for Job types and forms: Locate the Common and Company for the available API endpoints.

Use Transfer Documents endpoint

  • GET/v1/company/job-types: Return list of job type supported in Onix Work. For more information, please refer to the description of Onix Open API.
  • GET/v1/company/forms: Return the list of forms which is enabled by your company in Onix Work. For more information, please refer to the description of Onix Open API.
    image
  • POST/v1/jobs: Import job for equipment
    • To create or update a job by sending the required payload. Please ensure that you provide accurate mandatory information*: jobType, jobForm, filed, equipment.*
    • Some of the information is acquired from GET endpoints
      • locationID – GET/v1/company/{companyOwner}/locations
      • jobType – GET/v1/company/job-types
      • jobForm – GET/v1/company/forms

For more information about each field’s meaning and use guide, use Schema as an official reference.

image
image975×504 43 KB

image
image975×520 47.9 KB

  • POST/v1/jobs/{jobId}/documents Import document for job

    • To create (upload) a document for job by sending the required payload. Please ensure that you provide accurate mandatory information: description, documentType, contentType, data.
    • The data is base64 string format; therefore please convert your documents into this format for using this endpoint.
    • For more information about each field’s meaning and use guide, please use Schema as an official reference.
      image
      image975×499 49.3 KB

  • POST/v1/equipment/{equipment-id}/documents: Import documents to equipment

    • To create (upload) a document for equipment by sending the required payload, please ensure that you accurately provide the following mandatory information: description, documentType, contentType, data.
    • The data is base64 string format; therefore please convert your documents into this format for using this endpoint.
    • For more information about each field’s meaning and use guide, use Schema as an official reference.