{ "openapi" : "3.1.0", "info" : { "title" : "System Accounts Management Component (Tenant and User Account Management", "description" : "Hosts the Tenant, User Management and Agent For Modules with their corresponding API Endpoints for the System Domain :: 2026-03-21T01:31:07.609861187Z[UTC]", "termsOfService" : "https://arda.cards/terms-of-service", "contact" : { "name" : "Arda Cards", "url" : "https://arda.cards", "email" : "systems@arda.cards" }, "license" : { "name" : "Arda License", "url" : "https://arda.cards/terms-of-service", "identifier" : "Arda Proprietary" }, "version" : "v1" }, "externalDocs" : { "description" : "Documentation for Arda Cards Integration Developers", "url" : "https://arda.cards/developers" }, "servers" : [ { "url" : "https://stage.alpha002.io.arda.cards", "description" : "Server for System Accounts Management Component (Tenant and User Account Management with version v1" } ], "tags" : [ ], "paths" : { "/v1/agent-for/agent-for" : { "post" : { "tags" : [ "v1" ], "summary" : "Add new agent-for", "description" : "Add new agent-for", "operationId" : "agent-for-add", "parameters" : [ { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "requestBody" : { "description" : "Input Information to create or update agent-for", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.api.AgentForInput" } } }, "required" : true }, "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } }, "/v1/agent-for/agent-for/{entity-id}" : { "get" : { "tags" : [ "v1" ], "summary" : "Get agent-for by id with time coordinates", "description" : "Get agent-for by id with time coordinates", "operationId" : "agent-for-entity-id-get-by-eid", "parameters" : [ { "name" : "entity-id", "in" : "path", "description" : "The Entity Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "object", "title" : "*" } }, { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } }, { "name" : "recordedasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false }, "put" : { "tags" : [ "v1" ], "summary" : "Update a agent-for", "description" : "Update a agent-for", "operationId" : "agent-for-entity-id-update", "parameters" : [ { "name" : "entity-id", "in" : "path", "description" : "The Entity Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "object", "title" : "*" } }, { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "requestBody" : { "description" : "Input Information to create or update agent-for", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.api.AgentForInput" } } }, "required" : true }, "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false }, "delete" : { "tags" : [ "v1" ], "summary" : "Delete agent-for by id with time coordinates", "description" : "Delete agent-for by id with time coordinates", "operationId" : "agent-for-entity-id-remove", "parameters" : [ { "name" : "entity-id", "in" : "path", "description" : "The Entity Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "object", "title" : "*" } }, { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } }, "/v1/agent-for/agent-for/rid/{entity-record-id}" : { "get" : { "tags" : [ "v1" ], "summary" : "Get Order Header by Record Id", "description" : "Get Order Header by Record Id.", "operationId" : "agent-for-rid-entity-record-id-get-by-rid", "parameters" : [ { "name" : "entity-record-id", "in" : "path", "description" : "The Record Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "object", "title" : "*" } }, { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } }, "/v1/agent-for/agent-for/query" : { "post" : { "tags" : [ "v1" ], "summary" : "Query agent-for first page", "description" : "Query agent-for first page", "operationId" : "agent-for-query-create", "parameters" : [ { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } }, { "name" : "recordedasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "requestBody" : { "description" : "Query to find agent-for", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.lang.query.Query" } } }, "required" : true }, "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.PageResult_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } }, "/v1/agent-for/agent-for/query/{page}" : { "get" : { "tags" : [ "v1" ], "summary" : "Get a Page of agent-for by page id", "description" : "Get a Page of agent-for by page id", "operationId" : "agent-for-query-page-get-page", "parameters" : [ { "name" : "page", "in" : "path", "description" : "The Page Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } }, { "name" : "recordedasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.PageResult_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } }, "/v1/agent-for/agent-for/{entity-id}/history" : { "post" : { "tags" : [ "v1" ], "summary" : "agent-for History first page", "description" : "agent-for History first page", "operationId" : "agent-for-entity-id-history-query", "parameters" : [ { "name" : "entity-id", "in" : "path", "description" : "The Entity Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "object", "title" : "*" } }, { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "requestBody" : { "description" : "History Request for agent-for", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.server.dataauthority.HistoryRequestBody" } } }, "required" : true }, "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.PageResult_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } }, "/v1/agent-for/agent-for/{entity-id}/history/{page}" : { "get" : { "tags" : [ "v1" ], "summary" : "Get a Page of agent-for by page id", "description" : "Get a Page of agent-for by page id", "operationId" : "agent-for-entity-id-history-page-get-page", "parameters" : [ { "name" : "entity-id", "in" : "path", "description" : "The Entity Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "object", "title" : "*" } }, { "name" : "page", "in" : "path", "description" : "The Page Id of the agent-for", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.PageResult_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } }, "/v1/agent-for/agent-for/bulk" : { "put" : { "tags" : [ "v1" ], "summary" : "Bulk update agent-for entities", "description" : "Update multiple agent-for entities in a single atomic transaction. All updates succeed or none if any fails.", "operationId" : "agent-for-bulk-bulk-update", "parameters" : [ { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "requestBody" : { "description" : "Bulk update request containing list of entity ID + payload pairs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.server.dataauthority.BulkUpdateRequest_cards.arda.accounts.system.userAccount.api.AgentForInput" } } }, "required" : true }, "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" }, "title" : "ListOfEntityRecordOfAgentForEntityAndAgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false }, "post" : { "tags" : [ "v1" ], "summary" : "Bulk add agent-for entities", "description" : "Add multiple agent-for entities in a single atomic transaction. All items are created or none if any fails.", "operationId" : "agent-for-bulk-bulk-add", "parameters" : [ { "name" : "X-Author", "in" : "header", "description" : "The Author of the Call, only required if JWT is not being used for authentication", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "X-Request-ID", "in" : "header", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "effectiveasof", "in" : "query", "description" : "", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "title" : "Long" } } ], "requestBody" : { "description" : "List of agent-for inputs to add in a single atomic transaction", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.api.AgentForInput" }, "title" : "ListOfAgentForInput" } } }, "required" : true }, "responses" : { "100" : { "description" : "Continue", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "101" : { "description" : "Switching Protocols", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "102" : { "description" : "Processing", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "200" : { "description" : "Successful Response", "headers" : { "X-Request-ID" : { "description" : "A unique identifier for the request, the server will generate one if not provided", "required" : true, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" }, "title" : "ListOfEntityRecordOfAgentForEntityAndAgentForMetadata" } } } }, "201" : { "description" : "Created", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "202" : { "description" : "Accepted", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "203" : { "description" : "Non-Authoritative Information", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "204" : { "description" : "No Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "205" : { "description" : "Reset Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "206" : { "description" : "Partial Content", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "207" : { "description" : "Multi-Status", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "300" : { "description" : "Multiple Choices", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "301" : { "description" : "Moved Permanently", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "302" : { "description" : "Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "303" : { "description" : "See Other", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "304" : { "description" : "Not Modified", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "305" : { "description" : "Use Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "306" : { "description" : "Switch Proxy", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "307" : { "description" : "Temporary Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "308" : { "description" : "Permanent Redirect", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "400" : { "description" : "Bad Request", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "401" : { "description" : "Unauthorized", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "402" : { "description" : "Payment Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "403" : { "description" : "Forbidden", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "404" : { "description" : "Not Found", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "406" : { "description" : "Not Acceptable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "407" : { "description" : "Proxy Authentication Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "408" : { "description" : "Request Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "409" : { "description" : "Conflict", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "410" : { "description" : "Gone", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "411" : { "description" : "Length Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "412" : { "description" : "Precondition Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "413" : { "description" : "Payload Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "414" : { "description" : "Request-URI Too Long", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "415" : { "description" : "Unsupported Media Type", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "416" : { "description" : "Requested Range Not Satisfiable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "417" : { "description" : "Expectation Failed", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "422" : { "description" : "Unprocessable Entity", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "423" : { "description" : "Locked", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "424" : { "description" : "Failed Dependency", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "425" : { "description" : "Too Early", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "426" : { "description" : "Upgrade Required", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "431" : { "description" : "Request Header Fields Too Large", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "501" : { "description" : "Not Implemented", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "502" : { "description" : "Bad Gateway", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "503" : { "description" : "Service Unavailable", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "504" : { "description" : "Gateway Timeout", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "505" : { "description" : "HTTP Version Not Supported", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "506" : { "description" : "Variant Also Negotiates", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } }, "507" : { "description" : "Insufficient Storage", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.types.ErrorResponse" } } } } }, "deprecated" : false } } }, "components" : { "schemas" : { "cards.arda.common.lib.reference.Reference.Value" : { "type" : "object", "properties" : { "local" : { "type" : "string", "format" : "uuid" }, "homes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/7c53d296-e27d-46d5-be01-6d976c8175c3" }, "title" : "ListOfResourceHome" } }, "required" : [ "homes", "local" ], "title" : "ReferenceValue" }, "cards.arda.accounts.system.userAccount.business.RoleType" : { "type" : "string", "enum" : [ "USER", "ADMIN" ], "title" : "RoleType" }, "cards.arda.accounts.system.userAccount.business.AffiliationStatus" : { "type" : "string", "enum" : [ "INVITED", "ACTIVE", "SUSPENDED", "REVOKED" ], "title" : "AffiliationStatus" }, "kotlinx.serialization.json.JsonElement" : { "type" : "object", "properties" : { }, "title" : "JsonElement" }, "cards.arda.accounts.system.userAccount.api.AgentForInput" : { "type" : "object", "properties" : { "userAccount" : { "$ref" : "#/components/schemas/cards.arda.common.lib.reference.Reference.Value" }, "tenant" : { "$ref" : "#/components/schemas/cards.arda.common.lib.reference.Reference.Value" }, "role" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.business.RoleType" }, "status" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.business.AffiliationStatus" }, "settings" : { "$ref" : "#/components/schemas/kotlinx.serialization.json.JsonElement" } }, "required" : [ "role", "settings", "status", "tenant", "userAccount" ], "title" : "AgentForInput" }, "cards.arda.common.lib.api.rest.types.ErrorResponse" : { "type" : "object", "properties" : { "responseMessage" : { "type" : "string", "title" : "String" }, "code" : { "type" : "integer", "format" : "int32", "title" : "Int" }, "details" : { "oneOf" : [ { "type" : "null" }, { "$ref" : "#/components/schemas/kotlinx.serialization.json.JsonElement" } ] } }, "required" : [ "code", "responseMessage" ], "title" : "ErrorResponse" }, "cards.arda.common.lib.persistence.bitemporal.TimeCoordinates" : { "type" : "object", "properties" : { "effective" : { "type" : "integer", "format" : "int64", "title" : "Long" }, "recorded" : { "type" : "integer", "format" : "int64", "title" : "Long" } }, "required" : [ "effective", "recorded" ], "title" : "TimeCoordinates" }, "cards.arda.accounts.system.userAccount.business.AgentFor.Entity" : { "type" : "object", "properties" : { "eId" : { "type" : "string", "format" : "uuid" }, "userAccount" : { "$ref" : "#/components/schemas/cards.arda.common.lib.reference.Reference.Value" }, "tenant" : { "$ref" : "#/components/schemas/cards.arda.common.lib.reference.Reference.Value" }, "role" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.business.RoleType" }, "status" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.business.AffiliationStatus" }, "settings" : { "$ref" : "#/components/schemas/kotlinx.serialization.json.JsonElement" } }, "required" : [ "eId", "role", "settings", "status", "tenant", "userAccount" ], "title" : "AgentForEntity" }, "cards.arda.accounts.system.userAccount.business.AgentForMetadata" : { "type" : "object", "properties" : { }, "title" : "AgentForMetadata" }, "cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" : { "type" : "object", "properties" : { "rId" : { "type" : "string", "format" : "uuid" }, "asOf" : { "$ref" : "#/components/schemas/cards.arda.common.lib.persistence.bitemporal.TimeCoordinates" }, "payload" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.business.AgentFor.Entity" }, "metadata" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.business.AgentForMetadata" }, "author" : { "type" : "string", "title" : "String" }, "createdBy" : { "type" : "string", "title" : "String" }, "createdAt" : { "$ref" : "#/components/schemas/cards.arda.common.lib.persistence.bitemporal.TimeCoordinates" }, "previous" : { "type" : [ "null", "string" ], "format" : "uuid" }, "retired" : { "type" : "boolean", "title" : "Boolean" } }, "required" : [ "asOf", "author", "createdAt", "createdBy", "metadata", "payload", "rId", "retired" ], "title" : "EntityRecordOfAgentForEntityAndAgentForMetadata" }, "Filter" : { "type" : "object", "description" : "A filter expression supporting literals, composites, transforms, and terms. Discrimination is key-based: the presence of specific keys determines the subtype.", "oneOf" : [ { "description" : "Filter.TRUE - matches all records", "enum" : [ true ] }, { "description" : "Filter.FALSE - matches no records", "enum" : [ false ] }, { "description" : "Filter.And - logical AND of clauses", "properties" : { "and" : { "description" : "List of filter clauses to AND together", "items" : { "description" : "A nested Filter expression" } } }, "required" : [ "and" ] }, { "description" : "Filter.Or - logical OR of clauses", "properties" : { "or" : { "description" : "List of filter clauses to OR together", "items" : { "description" : "A nested Filter expression" } } }, "required" : [ "or" ] }, { "description" : "Filter.Not - logical negation of a clause", "properties" : { "not" : { "description" : "A nested Filter expression to negate" } }, "required" : [ "not" ] }, { "description" : "Filter.IsNull - matches records where the locator field is null", "properties" : { "isNull" : { "description" : "Field locator path" } }, "required" : [ "isNull" ] }, { "description" : "Filter.IsNotNull - matches records where the locator field is not null", "properties" : { "isNotNull" : { "description" : "Field locator path" } }, "required" : [ "isNotNull" ] }, { "description" : "Filter.Eq - matches records where locator equals value", "properties" : { "locator" : { "description" : "Field locator path" }, "eq" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } }, "required" : [ "eq", "locator" ] }, { "description" : "Filter.Ne - matches records where locator does not equal value", "properties" : { "locator" : { "description" : "Field locator path" }, "ne" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } }, "required" : [ "locator", "ne" ] }, { "description" : "Filter.Gt - matches records where locator is greater than value", "properties" : { "locator" : { "description" : "Field locator path" }, "gt" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } }, "required" : [ "gt", "locator" ] }, { "description" : "Filter.Ge - matches records where locator is greater than or equal to value", "properties" : { "locator" : { "description" : "Field locator path" }, "ge" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } }, "required" : [ "ge", "locator" ] }, { "description" : "Filter.Lt - matches records where locator is less than value", "properties" : { "locator" : { "description" : "Field locator path" }, "lt" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } }, "required" : [ "locator", "lt" ] }, { "description" : "Filter.Le - matches records where locator is less than or equal to value", "properties" : { "locator" : { "description" : "Field locator path" }, "le" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } }, "required" : [ "le", "locator" ] }, { "description" : "Filter.RegEx - matches records where locator matches regex pattern", "properties" : { "locator" : { "description" : "Field locator path" }, "regex" : { "description" : "Regular expression pattern" } }, "required" : [ "locator", "regex" ] }, { "description" : "Filter.In - matches records where locator value is in the set", "properties" : { "in" : { "description" : "Set term body with locator and values", "properties" : { "locator" : { "description" : "Field locator path" }, "values" : { "description" : "Set of values to match against", "items" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } } }, "required" : [ "locator", "values" ] } }, "required" : [ "in" ] }, { "description" : "Filter.NotIn - matches records where locator value is not in the set", "properties" : { "notIn" : { "description" : "Set term body with locator and values", "properties" : { "locator" : { "description" : "Field locator path" }, "values" : { "description" : "Set of values to match against", "items" : { "description" : "Comparison value (string, number, or boolean - auto-coerced at runtime)", "oneOf" : [ { }, { }, { } ] } } }, "required" : [ "locator", "values" ] } }, "required" : [ "notIn" ] } ], "title" : "Filter" }, "cards.arda.common.lib.lang.query.Sort" : { "type" : "object", "properties" : { "entries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/cards.arda.common.lib.lang.query.SortEntry" }, "title" : "ListOfSortEntry" } }, "required" : [ "entries" ], "title" : "Sort" }, "cards.arda.common.lib.lang.query.SortEntry" : { "type" : "object", "properties" : { "key" : { "type" : "string", "title" : "PropertyPath" }, "direction" : { "$ref" : "#/components/schemas/cards.arda.common.lib.lang.query.SortDirection" } }, "required" : [ "direction", "key" ], "title" : "SortEntry" }, "cards.arda.common.lib.lang.query.SortDirection" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "title" : "SortDirection" }, "cards.arda.common.lib.lang.query.Pagination" : { "type" : "object", "properties" : { "index" : { "type" : "integer", "format" : "int32", "title" : "Int" }, "size" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, "required" : [ "index", "size" ], "title" : "Pagination" }, "cards.arda.common.lib.lang.query.Query" : { "type" : "object", "properties" : { "filter" : { "$ref" : "#/components/schemas/Filter" }, "sort" : { "$ref" : "#/components/schemas/cards.arda.common.lib.lang.query.Sort" }, "paginate" : { "$ref" : "#/components/schemas/cards.arda.common.lib.lang.query.Pagination" } }, "required" : [ "filter", "paginate", "sort" ], "title" : "Query" }, "cards.arda.common.lib.module.dataauthority.PageResult_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" : { "type" : "object", "properties" : { "thisPage" : { "type" : "string", "title" : "String" }, "nextPage" : { "type" : "string", "title" : "String" }, "previousPage" : { "type" : [ "null", "string" ], "title" : "String" }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/cards.arda.common.lib.module.dataauthority.EntityRecord_cards.arda.accounts.system.userAccount.business.AgentFor.Entity-cards.arda.accounts.system.userAccount.business.AgentForMetadata" }, "title" : "ListOfEntityRecordOfAgentForEntityAndAgentForMetadata" }, "totalCount" : { "type" : [ "null", "integer" ], "format" : "int64", "title" : "Long" } }, "required" : [ "nextPage", "results", "thisPage" ], "title" : "PageResultOfAgentForEntityAndAgentForMetadata" }, "cards.arda.common.lib.api.rest.server.dataauthority.HistoryRequestBody" : { "type" : "object", "properties" : { "since" : { "$ref" : "#/components/schemas/cards.arda.common.lib.persistence.bitemporal.TimeCoordinates" }, "until" : { "$ref" : "#/components/schemas/cards.arda.common.lib.persistence.bitemporal.TimeCoordinates" }, "page" : { "$ref" : "#/components/schemas/cards.arda.common.lib.lang.query.Pagination" } }, "required" : [ "page", "since", "until" ], "title" : "HistoryRequestBody" }, "cards.arda.common.lib.api.rest.server.dataauthority.BulkUpdateEntry_cards.arda.accounts.system.userAccount.api.AgentForInput" : { "type" : "object", "properties" : { "eId" : { "type" : "string", "format" : "uuid" }, "payload" : { "$ref" : "#/components/schemas/cards.arda.accounts.system.userAccount.api.AgentForInput" } }, "required" : [ "eId", "payload" ], "title" : "BulkUpdateEntryOfAgentForInput" }, "cards.arda.common.lib.api.rest.server.dataauthority.BulkUpdateRequest_cards.arda.accounts.system.userAccount.api.AgentForInput" : { "type" : "object", "properties" : { "updates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/cards.arda.common.lib.api.rest.server.dataauthority.BulkUpdateEntry_cards.arda.accounts.system.userAccount.api.AgentForInput" }, "title" : "ListOfBulkUpdateEntryOfAgentForInput" } }, "required" : [ "updates" ], "title" : "BulkUpdateRequestOfAgentForInput" } }, "examples" : { }, "securitySchemes" : { "auth-arda" : { "type" : "apiKey", "name" : "auth-arda", "in" : "header", "scheme" : "bearer", "bearerFormat" : "String, provided by Arda Systems" }, "auth-postConfirmation" : { "type" : "apiKey", "name" : "auth-postConfirmation", "in" : "header", "scheme" : "bearer", "bearerFormat" : "String, provided by Arda Systems" } } }, "webhooks" : { } }