@one-view/pd-oneview-agent-update-types v0.0.7

FORMAT: 1A HOST: https://api.pd-oneview.net/agent-update

pd-oneview-agent-update

example delivery project

start agent bulk upload /v1/start-upload

Post POST

• Request

  • Headers

      Authorization: bearer token

• Attributes (StartUploadPayload)

• Response 200 (application/json)

  • Attributes (StartUploadResponse)

• Response 400 (application/json)

  • Attributes (Error)

• Response 404 (application/json)

  • Attributes (Error)

• Response 409 (application/json)

  • Attributes (Error)

• Response 500 (application/json)

  • Attributes (Error)

• Response 502 (application/json)

  • Attributes (Error)

• Response 503 (application/json)

  • Attributes (Error)

Organisations /v1/organisations

Get list of organisations GET

• Request

  • Headers

      Authorization: bearer token

• Response 200 (application/json)

  • Attributes (GetOrganisationsResponse)

• Response 400 (application/json)

  • Attributes (Error)

• Response 404 (application/json)

  • Attributes (Error)

• Response 500 (application/json)

  • Attributes (Error)

• Response 503 (application/json)

  • Attributes (Error)

Data Structures

error_object (object)

• status (string)
• title (string)
• data (string)

Error (object)

• errors (arrayerror_object, fixed-type)

StartUploadResponse

• request_id : 9ca60006-8053-4bea-bfaf-82a9c6da050a (string) - request id for submitted upload task
• organisation : ibexpk (string) - agent organisation

StartUploadPayload

• organisation : ibexpk (string) - agent organisation

GetOrganisationsResponse

• organisations (arrayOrganisation, fixed-type)

Organisation

• name (string)
• sheet_id (string)
• sheet_name (string)