Delete work order
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Delete work order

  • Dark
    Light
  • PDF

Article summary

Post
/deleteWorkOrder/

NOTE: This API is provided by a separate service.

This service will search existing pre-connected circuit(s) from KeyCom based on provided parameters. It will only accept circuits with the circuit section usage states of pre-connected or partially pre-connected. If a single unambiguous circuit is found, it will then be completely deleted.

Available from product version 2024.3.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

search criteria for circuit to delete work order

object
contractNumber
string

circuit contract number as alternative search criteria

name
string

circuit identifier as alternative search criteria

name2
string

circuit alternate identifier as alternative search criteria

orderNumber
string

circuit order number as alternative search criteria

circuitId
integer

ID of circuit as primary search criteria

Responses
204

Object deleted

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?