Open API Spec

{
	"openapi": "3.0.3",
	"info": {
		"title": "Account",
		"version": "4.0"
	},
	"servers": [{
		"url": "https://{yourCompany}.agiliron.net/agiliron/api-40/Accounts",
		"variables": {
			"yourCompany": {
				"default": "yourCompany"
			}
		}
	}],
	"components": {
		"securitySchemes": {
			"sec0": {
				"_id": "5c88abd5a128010014458562",
				"type": "apiKey",
				"in": "query",
				"name": "key"
			}
		}
	},
	"security": [{
		"sec0": []
	}],
	"paths": {
		"/{accountParams}": {
			"delete": {
				"summary": "Delete Account",
				"description": "",
				"operationId": "delete-account",
				"parameters": [{
					"name": "accountParams",
					"in": "path",
					"description": "e.g. Account ID/Account  Name/Account Email/Account Number",
					"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
			}
		},
		"": {
			"post": {
				"summary": "Add Account",
				"description": "",
				"operationId": "add-account",
				"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 Account",
				"description": "",
				"operationId": "read-account",
				"parameters": [{
					"name": "Accept",
					"in": "header",
					"description": "e.g. application/json or application/xml",
					"schema": {
						"type": "string"
					}
				}, {
					"name": "filter",
					"in": "query",
					"schema": {
						"type": "string"
					}
				}, {
					"name": "customview",
					"in": "query",
					"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
			},
			"put": {
				"summary": "Update Account",
				"description": "",
				"operationId": "update-account",
				"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
			}
		}
	},
	"x-readme": {
		"headers": [],
		"explorer-enabled": true,
		"proxy-enabled": true,
		"samples-enabled": true
	},
	"x-readme-fauxas": true
}

© Copyright 2022 Agiliron - All Rights Reserved.