Open API Spec

{ "openapi": "3.1.0", "info": { "title": "WorkOrders", "version": "4.0" }, "servers": [ { "url": "https://{yourCompany}.agiliron.net/agiliron/api-40/WorkOrders", "variables": { "yourCompany": { "default": "yourCompany" } } } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "query", "name": "key" }, "sec1": { "type": "apiKey", "in": "header", "name": "apiKey" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/": { "post": { "summary": "Add WorkOrders", "description": "", "operationId": "add-workorders", "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json or application/xml", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "JSON": { "type": "string", "description": "Enter JSON Data", "format": "json" }, "XML": { "type": "string", "description": "Enter XML Data" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false }, "put": { "summary": "Update WorkOrders", "description": "", "operationId": "update-workorders", "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json or application/xml", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "JSON": { "type": "string", "description": "Enter JSON Data", "format": "json" }, "XML": { "type": "string", "description": "Enter XML Data" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false }, "get": { "summary": "Read WorkOrders", "description": "", "operationId": "read-workorders", "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "customview", "in": "query", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json or application/xml", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/{workordersParams}": { "delete": { "summary": "Delete WorkOrders", "description": "", "operationId": "delete-workorders", "parameters": [ { "name": "workorderParams", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "Accept", "in": "header", "description": "e.g. application/json or application/xml", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true }

© Copyright 2022 Agiliron - All Rights Reserved.